ngrok-api 0.18.0 → 0.21.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (587) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ci.yml +7 -7
  3. data/.gitignore +15 -13
  4. data/.rubocop.yml +30 -28
  5. data/.rubocop_airbnb.yml +4 -2
  6. data/.simplecov +3 -1
  7. data/CHANGELOG.md +8 -0
  8. data/CODE_OF_CONDUCT.md +45 -0
  9. data/Gemfile +34 -32
  10. data/Guardfile +18 -16
  11. data/README.md +94 -61
  12. data/Rakefile +9 -7
  13. data/doc/NgrokAPI/Client.html +229 -125
  14. data/doc/NgrokAPI/Error.html +12 -12
  15. data/doc/NgrokAPI/Errors/NotFoundError.html +12 -12
  16. data/doc/NgrokAPI/Errors.html +4 -4
  17. data/doc/NgrokAPI/HttpClient.html +208 -65
  18. data/doc/NgrokAPI/Models/APIKey.html +220 -90
  19. data/doc/NgrokAPI/Models/AWSAuth.html +113 -61
  20. data/doc/NgrokAPI/Models/AWSCredentials.html +120 -68
  21. data/doc/NgrokAPI/Models/AWSRole.html +101 -49
  22. data/doc/NgrokAPI/Models/AbuseReport.html +165 -109
  23. data/doc/NgrokAPI/Models/AbuseReportHostname.html +113 -61
  24. data/doc/NgrokAPI/Models/AgentIngress.html +365 -155
  25. data/doc/NgrokAPI/Models/AgentIngressCertJob.html +817 -0
  26. data/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +669 -0
  27. data/doc/NgrokAPI/Models/AgentIngressCertStatus.html +669 -0
  28. data/doc/NgrokAPI/Models/ApplicationSession.html +1414 -0
  29. data/doc/NgrokAPI/Models/ApplicationUser.html +1336 -0
  30. data/doc/NgrokAPI/Models/BrowserSession.html +743 -0
  31. data/doc/NgrokAPI/Models/CertificateAuthority.html +223 -167
  32. data/doc/NgrokAPI/Models/Credential.html +225 -95
  33. data/doc/NgrokAPI/Models/Endpoint.html +215 -159
  34. data/doc/NgrokAPI/Models/EndpointBackend.html +120 -68
  35. data/doc/NgrokAPI/Models/EndpointBackendMutate.html +120 -68
  36. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +147 -95
  37. data/doc/NgrokAPI/Models/EndpointCompression.html +108 -56
  38. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +120 -68
  39. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +120 -68
  40. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +120 -68
  41. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +120 -68
  42. data/doc/NgrokAPI/Models/EndpointOAuth.html +166 -114
  43. data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +891 -0
  44. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +149 -97
  45. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +166 -114
  46. data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +891 -0
  47. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +149 -97
  48. data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +891 -0
  49. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +149 -97
  50. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +410 -62
  51. data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +891 -0
  52. data/doc/NgrokAPI/Models/EndpointOIDC.html +183 -131
  53. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +125 -73
  54. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +125 -73
  55. data/doc/NgrokAPI/Models/EndpointSAML.html +244 -176
  56. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +197 -141
  57. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +125 -73
  58. data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +120 -68
  59. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +125 -73
  60. data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +108 -56
  61. data/doc/NgrokAPI/Models/EventDestination.html +178 -122
  62. data/doc/NgrokAPI/Models/EventSource.html +136 -80
  63. data/doc/NgrokAPI/Models/EventSourceList.html +112 -56
  64. data/doc/NgrokAPI/Models/EventSourceReplace.html +125 -73
  65. data/doc/NgrokAPI/Models/EventSubscription.html +178 -122
  66. data/doc/NgrokAPI/Models/EventTarget.html +206 -80
  67. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +120 -68
  68. data/doc/NgrokAPI/Models/EventTargetDatadog.html +817 -0
  69. data/doc/NgrokAPI/Models/EventTargetFirehose.html +120 -68
  70. data/doc/NgrokAPI/Models/EventTargetKinesis.html +113 -61
  71. data/doc/NgrokAPI/Models/FailoverBackend.html +186 -130
  72. data/doc/NgrokAPI/Models/HTTPResponseBackend.html +202 -146
  73. data/doc/NgrokAPI/Models/HTTPSEdge.html +207 -151
  74. data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +272 -216
  75. data/doc/NgrokAPI/Models/IPPolicy.html +178 -122
  76. data/doc/NgrokAPI/Models/IPPolicyRule.html +201 -145
  77. data/doc/NgrokAPI/Models/IPRestriction.html +190 -134
  78. data/doc/NgrokAPI/Models/IdentityProvider.html +669 -0
  79. data/doc/NgrokAPI/Models/Listable.html +130 -130
  80. data/doc/NgrokAPI/Models/Location.html +817 -0
  81. data/doc/NgrokAPI/Models/Ref.html +119 -63
  82. data/doc/NgrokAPI/Models/ReservedAddr.html +189 -133
  83. data/doc/NgrokAPI/Models/ReservedDomain.html +231 -175
  84. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +130 -78
  85. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +120 -68
  86. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +120 -68
  87. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +197 -141
  88. data/doc/NgrokAPI/Models/SSHCredential.html +232 -102
  89. data/doc/NgrokAPI/Models/SSHHostCertificate.html +226 -170
  90. data/doc/NgrokAPI/Models/SSHUserCertificate.html +240 -184
  91. data/doc/NgrokAPI/Models/TCPEdge.html +204 -148
  92. data/doc/NgrokAPI/Models/TLSCertificate.html +279 -223
  93. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +120 -68
  94. data/doc/NgrokAPI/Models/TLSEdge.html +216 -160
  95. data/doc/NgrokAPI/Models/Tunnel.html +205 -149
  96. data/doc/NgrokAPI/Models/TunnelGroupBackend.html +191 -135
  97. data/doc/NgrokAPI/Models/TunnelSession.html +193 -137
  98. data/doc/NgrokAPI/Models/UserAgent.html +965 -0
  99. data/doc/NgrokAPI/Models/WeightedBackend.html +186 -130
  100. data/doc/NgrokAPI/Models.html +6 -6
  101. data/doc/NgrokAPI/PagedIterator.html +53 -53
  102. data/doc/NgrokAPI/Services/APIKeysClient.html +302 -127
  103. data/doc/NgrokAPI/Services/AbuseReportsClient.html +176 -39
  104. data/doc/NgrokAPI/Services/AgentIngressesClient.html +366 -133
  105. data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +1131 -0
  106. data/doc/NgrokAPI/Services/ApplicationUsersClient.html +1131 -0
  107. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +276 -123
  108. data/doc/NgrokAPI/Services/CredentialsClient.html +328 -133
  109. data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +22 -26
  110. data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +22 -26
  111. data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +22 -26
  112. data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +22 -26
  113. data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +22 -26
  114. data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +22 -26
  115. data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +22 -26
  116. data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +22 -26
  117. data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +22 -26
  118. data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +22 -26
  119. data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +22 -26
  120. data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +319 -129
  121. data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +528 -113
  122. data/doc/NgrokAPI/Services/EdgesTCPClient.html +319 -129
  123. data/doc/NgrokAPI/Services/EdgesTLSClient.html +353 -133
  124. data/doc/NgrokAPI/Services/EndpointsClient.html +22 -26
  125. data/doc/NgrokAPI/Services/EventDestinationsClient.html +302 -127
  126. data/doc/NgrokAPI/Services/EventSourcesClient.html +244 -105
  127. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +302 -127
  128. data/doc/NgrokAPI/Services/FailoverBackendsClient.html +282 -127
  129. data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +322 -129
  130. data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +22 -26
  131. data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +22 -26
  132. data/doc/NgrokAPI/Services/IPPoliciesClient.html +258 -123
  133. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +317 -130
  134. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +318 -127
  135. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +278 -123
  136. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +388 -171
  137. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +318 -123
  138. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +345 -132
  139. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +354 -123
  140. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +397 -126
  141. data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +22 -26
  142. data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +22 -26
  143. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +296 -125
  144. data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +22 -26
  145. data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +22 -26
  146. data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +22 -26
  147. data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +22 -26
  148. data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +282 -127
  149. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +22 -26
  150. data/doc/NgrokAPI/Services/TunnelsClient.html +22 -26
  151. data/doc/NgrokAPI/Services/WeightedBackendsClient.html +285 -130
  152. data/doc/NgrokAPI/Services.html +6 -6
  153. data/doc/NgrokAPI.html +6 -6
  154. data/doc/_index.html +139 -8
  155. data/doc/class_list.html +1 -1
  156. data/doc/file.README.html +55 -51
  157. data/doc/frames.html +1 -1
  158. data/doc/index.html +55 -51
  159. data/doc/method_list.html +4383 -2175
  160. data/doc/top-level-namespace.html +4 -4
  161. data/docs/NgrokAPI/Client.html +229 -125
  162. data/docs/NgrokAPI/Error.html +12 -12
  163. data/docs/NgrokAPI/Errors/NotFoundError.html +12 -12
  164. data/docs/NgrokAPI/Errors.html +4 -4
  165. data/docs/NgrokAPI/HttpClient.html +208 -65
  166. data/docs/NgrokAPI/Models/APIKey.html +220 -90
  167. data/docs/NgrokAPI/Models/AWSAuth.html +113 -61
  168. data/docs/NgrokAPI/Models/AWSCredentials.html +120 -68
  169. data/docs/NgrokAPI/Models/AWSRole.html +101 -49
  170. data/docs/NgrokAPI/Models/AbuseReport.html +165 -109
  171. data/docs/NgrokAPI/Models/AbuseReportHostname.html +113 -61
  172. data/docs/NgrokAPI/Models/AgentIngress.html +365 -155
  173. data/docs/NgrokAPI/Models/AgentIngressCertJob.html +817 -0
  174. data/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +669 -0
  175. data/docs/NgrokAPI/Models/AgentIngressCertStatus.html +669 -0
  176. data/docs/NgrokAPI/Models/ApplicationSession.html +1414 -0
  177. data/docs/NgrokAPI/Models/ApplicationUser.html +1336 -0
  178. data/docs/NgrokAPI/Models/BrowserSession.html +743 -0
  179. data/docs/NgrokAPI/Models/CertificateAuthority.html +223 -167
  180. data/docs/NgrokAPI/Models/Credential.html +225 -95
  181. data/docs/NgrokAPI/Models/Endpoint.html +215 -159
  182. data/docs/NgrokAPI/Models/EndpointBackend.html +120 -68
  183. data/docs/NgrokAPI/Models/EndpointBackendMutate.html +120 -68
  184. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +147 -95
  185. data/docs/NgrokAPI/Models/EndpointCompression.html +108 -56
  186. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +120 -68
  187. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +120 -68
  188. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +120 -68
  189. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +120 -68
  190. data/docs/NgrokAPI/Models/EndpointOAuth.html +166 -114
  191. data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +891 -0
  192. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +149 -97
  193. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +166 -114
  194. data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +891 -0
  195. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +149 -97
  196. data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +891 -0
  197. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +149 -97
  198. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +410 -62
  199. data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +891 -0
  200. data/docs/NgrokAPI/Models/EndpointOIDC.html +183 -131
  201. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +125 -73
  202. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +125 -73
  203. data/docs/NgrokAPI/Models/EndpointSAML.html +244 -176
  204. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +197 -141
  205. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +125 -73
  206. data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +120 -68
  207. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +125 -73
  208. data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +108 -56
  209. data/docs/NgrokAPI/Models/EventDestination.html +178 -122
  210. data/docs/NgrokAPI/Models/EventSource.html +136 -80
  211. data/docs/NgrokAPI/Models/EventSourceList.html +112 -56
  212. data/docs/NgrokAPI/Models/EventSourceReplace.html +125 -73
  213. data/docs/NgrokAPI/Models/EventSubscription.html +178 -122
  214. data/docs/NgrokAPI/Models/EventTarget.html +206 -80
  215. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +120 -68
  216. data/docs/NgrokAPI/Models/EventTargetDatadog.html +817 -0
  217. data/docs/NgrokAPI/Models/EventTargetFirehose.html +120 -68
  218. data/docs/NgrokAPI/Models/EventTargetKinesis.html +113 -61
  219. data/docs/NgrokAPI/Models/FailoverBackend.html +186 -130
  220. data/docs/NgrokAPI/Models/HTTPResponseBackend.html +202 -146
  221. data/docs/NgrokAPI/Models/HTTPSEdge.html +207 -151
  222. data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +272 -216
  223. data/docs/NgrokAPI/Models/IPPolicy.html +178 -122
  224. data/docs/NgrokAPI/Models/IPPolicyRule.html +201 -145
  225. data/docs/NgrokAPI/Models/IPRestriction.html +190 -134
  226. data/docs/NgrokAPI/Models/IdentityProvider.html +669 -0
  227. data/docs/NgrokAPI/Models/Listable.html +130 -130
  228. data/docs/NgrokAPI/Models/Location.html +817 -0
  229. data/docs/NgrokAPI/Models/Ref.html +119 -63
  230. data/docs/NgrokAPI/Models/ReservedAddr.html +189 -133
  231. data/docs/NgrokAPI/Models/ReservedDomain.html +231 -175
  232. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +130 -78
  233. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +120 -68
  234. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +120 -68
  235. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +197 -141
  236. data/docs/NgrokAPI/Models/SSHCredential.html +232 -102
  237. data/docs/NgrokAPI/Models/SSHHostCertificate.html +226 -170
  238. data/docs/NgrokAPI/Models/SSHUserCertificate.html +240 -184
  239. data/docs/NgrokAPI/Models/TCPEdge.html +204 -148
  240. data/docs/NgrokAPI/Models/TLSCertificate.html +279 -223
  241. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +120 -68
  242. data/docs/NgrokAPI/Models/TLSEdge.html +216 -160
  243. data/docs/NgrokAPI/Models/Tunnel.html +205 -149
  244. data/docs/NgrokAPI/Models/TunnelGroupBackend.html +191 -135
  245. data/docs/NgrokAPI/Models/TunnelSession.html +193 -137
  246. data/docs/NgrokAPI/Models/UserAgent.html +965 -0
  247. data/docs/NgrokAPI/Models/WeightedBackend.html +186 -130
  248. data/docs/NgrokAPI/Models.html +6 -6
  249. data/docs/NgrokAPI/PagedIterator.html +53 -53
  250. data/docs/NgrokAPI/Services/APIKeysClient.html +302 -127
  251. data/docs/NgrokAPI/Services/AbuseReportsClient.html +176 -39
  252. data/docs/NgrokAPI/Services/AgentIngressesClient.html +366 -133
  253. data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +1131 -0
  254. data/docs/NgrokAPI/Services/ApplicationUsersClient.html +1131 -0
  255. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +276 -123
  256. data/docs/NgrokAPI/Services/CredentialsClient.html +328 -133
  257. data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +22 -26
  258. data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +22 -26
  259. data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +22 -26
  260. data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +22 -26
  261. data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +22 -26
  262. data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +22 -26
  263. data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +22 -26
  264. data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +22 -26
  265. data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +22 -26
  266. data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +22 -26
  267. data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +22 -26
  268. data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +319 -129
  269. data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +528 -113
  270. data/docs/NgrokAPI/Services/EdgesTCPClient.html +319 -129
  271. data/docs/NgrokAPI/Services/EdgesTLSClient.html +353 -133
  272. data/docs/NgrokAPI/Services/EndpointsClient.html +22 -26
  273. data/docs/NgrokAPI/Services/EventDestinationsClient.html +302 -127
  274. data/docs/NgrokAPI/Services/EventSourcesClient.html +244 -105
  275. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +302 -127
  276. data/docs/NgrokAPI/Services/FailoverBackendsClient.html +282 -127
  277. data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +322 -129
  278. data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +22 -26
  279. data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +22 -26
  280. data/docs/NgrokAPI/Services/IPPoliciesClient.html +258 -123
  281. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +317 -130
  282. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +318 -127
  283. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +278 -123
  284. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +388 -171
  285. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +318 -123
  286. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +345 -132
  287. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +354 -123
  288. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +397 -126
  289. data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +22 -26
  290. data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +22 -26
  291. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +296 -125
  292. data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +22 -26
  293. data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +22 -26
  294. data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +22 -26
  295. data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +22 -26
  296. data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +282 -127
  297. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +22 -26
  298. data/docs/NgrokAPI/Services/TunnelsClient.html +22 -26
  299. data/docs/NgrokAPI/Services/WeightedBackendsClient.html +285 -130
  300. data/docs/NgrokAPI/Services.html +6 -6
  301. data/docs/NgrokAPI.html +6 -6
  302. data/docs/_index.html +139 -8
  303. data/docs/class_list.html +1 -1
  304. data/docs/file.README.html +55 -51
  305. data/docs/frames.html +1 -1
  306. data/docs/index.html +55 -51
  307. data/docs/method_list.html +4383 -2175
  308. data/docs/top-level-namespace.html +4 -4
  309. data/lib/ngrokapi/client.rb +21 -11
  310. data/lib/ngrokapi/error.rb +2 -0
  311. data/lib/ngrokapi/errors/not_found_error.rb +2 -0
  312. data/lib/ngrokapi/http_client.rb +153 -131
  313. data/lib/ngrokapi/models/abuse_report.rb +22 -12
  314. data/lib/ngrokapi/models/abuse_report_hostname.rb +13 -7
  315. data/lib/ngrokapi/models/agent_ingress.rb +33 -16
  316. data/lib/ngrokapi/models/agent_ingress_cert_job.rb +37 -0
  317. data/lib/ngrokapi/models/agent_ingress_cert_policy.rb +33 -0
  318. data/lib/ngrokapi/models/agent_ingress_cert_status.rb +33 -0
  319. data/lib/ngrokapi/models/api_key.rb +24 -12
  320. data/lib/ngrokapi/models/application_session.rb +67 -0
  321. data/lib/ngrokapi/models/application_user.rb +63 -0
  322. data/lib/ngrokapi/models/aws_auth.rb +13 -7
  323. data/lib/ngrokapi/models/aws_credentials.rb +13 -7
  324. data/lib/ngrokapi/models/aws_role.rb +12 -6
  325. data/lib/ngrokapi/models/browser_session.rb +35 -0
  326. data/lib/ngrokapi/models/certificate_authority.rb +26 -16
  327. data/lib/ngrokapi/models/credential.rb +25 -13
  328. data/lib/ngrokapi/models/endpoint.rb +28 -18
  329. data/lib/ngrokapi/models/endpoint_backend.rb +13 -7
  330. data/lib/ngrokapi/models/endpoint_backend_mutate.rb +13 -7
  331. data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +17 -11
  332. data/lib/ngrokapi/models/endpoint_compression.rb +12 -6
  333. data/lib/ngrokapi/models/endpoint_ip_policy.rb +13 -7
  334. data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +13 -7
  335. data/lib/ngrokapi/models/endpoint_mutual_tls.rb +13 -7
  336. data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +13 -7
  337. data/lib/ngrokapi/models/endpoint_o_auth.rb +18 -12
  338. data/lib/ngrokapi/models/endpoint_o_auth_amazon.rb +39 -0
  339. data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +16 -10
  340. data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +18 -12
  341. data/lib/ngrokapi/models/endpoint_o_auth_git_lab.rb +39 -0
  342. data/lib/ngrokapi/models/endpoint_o_auth_google.rb +16 -10
  343. data/lib/ngrokapi/models/endpoint_o_auth_linked_in.rb +39 -0
  344. data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +16 -10
  345. data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +24 -10
  346. data/lib/ngrokapi/models/endpoint_o_auth_twitch.rb +39 -0
  347. data/lib/ngrokapi/models/endpoint_oidc.rb +20 -14
  348. data/lib/ngrokapi/models/endpoint_request_headers.rb +14 -8
  349. data/lib/ngrokapi/models/endpoint_response_headers.rb +14 -8
  350. data/lib/ngrokapi/models/endpoint_saml.rb +37 -21
  351. data/lib/ngrokapi/models/endpoint_saml_mutate.rb +26 -16
  352. data/lib/ngrokapi/models/endpoint_tls_termination.rb +14 -8
  353. data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +13 -7
  354. data/lib/ngrokapi/models/endpoint_webhook_validation.rb +14 -8
  355. data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +12 -6
  356. data/lib/ngrokapi/models/event_destination.rb +22 -12
  357. data/lib/ngrokapi/models/event_source.rb +19 -9
  358. data/lib/ngrokapi/models/event_source_list.rb +17 -7
  359. data/lib/ngrokapi/models/event_source_replace.rb +14 -8
  360. data/lib/ngrokapi/models/event_subscription.rb +22 -12
  361. data/lib/ngrokapi/models/event_target.rb +18 -10
  362. data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +13 -7
  363. data/lib/ngrokapi/models/event_target_datadog.rb +37 -0
  364. data/lib/ngrokapi/models/event_target_firehose.rb +13 -7
  365. data/lib/ngrokapi/models/event_target_kinesis.rb +13 -7
  366. data/lib/ngrokapi/models/failover_backend.rb +22 -12
  367. data/lib/ngrokapi/models/http_response_backend.rb +23 -13
  368. data/lib/ngrokapi/models/https_edge.rb +24 -14
  369. data/lib/ngrokapi/models/https_edge_route.rb +34 -24
  370. data/lib/ngrokapi/models/identity_provider.rb +33 -0
  371. data/lib/ngrokapi/models/ip_policy.rb +21 -11
  372. data/lib/ngrokapi/models/ip_policy_rule.rb +23 -13
  373. data/lib/ngrokapi/models/ip_restriction.rb +23 -13
  374. data/lib/ngrokapi/models/listable.rb +55 -53
  375. data/lib/ngrokapi/models/location.rb +37 -0
  376. data/lib/ngrokapi/models/ref.rb +17 -7
  377. data/lib/ngrokapi/models/reserved_addr.rb +23 -13
  378. data/lib/ngrokapi/models/reserved_domain.rb +29 -19
  379. data/lib/ngrokapi/models/reserved_domain_cert_job.rb +15 -9
  380. data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +13 -7
  381. data/lib/ngrokapi/models/reserved_domain_cert_status.rb +13 -7
  382. data/lib/ngrokapi/models/ssh_certificate_authority.rb +22 -12
  383. data/lib/ngrokapi/models/ssh_credential.rb +25 -13
  384. data/lib/ngrokapi/models/ssh_host_certificate.rb +27 -17
  385. data/lib/ngrokapi/models/ssh_user_certificate.rb +29 -19
  386. data/lib/ngrokapi/models/tcp_edge.rb +23 -13
  387. data/lib/ngrokapi/models/tls_certificate.rb +36 -26
  388. data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +13 -7
  389. data/lib/ngrokapi/models/tls_edge.rb +25 -15
  390. data/lib/ngrokapi/models/tunnel.rb +26 -16
  391. data/lib/ngrokapi/models/tunnel_group_backend.rb +23 -13
  392. data/lib/ngrokapi/models/tunnel_session.rb +25 -15
  393. data/lib/ngrokapi/models/user_agent.rb +41 -0
  394. data/lib/ngrokapi/models/weighted_backend.rb +22 -12
  395. data/lib/ngrokapi/paged_iterator.rb +44 -42
  396. data/lib/ngrokapi/services/abuse_reports_client.rb +27 -3
  397. data/lib/ngrokapi/services/agent_ingresses_client.rb +45 -14
  398. data/lib/ngrokapi/services/api_keys_client.rb +37 -12
  399. data/lib/ngrokapi/services/application_sessions_client.rb +141 -0
  400. data/lib/ngrokapi/services/application_users_client.rb +141 -0
  401. data/lib/ngrokapi/services/certificate_authorities_client.rb +33 -11
  402. data/lib/ngrokapi/services/credentials_client.rb +45 -16
  403. data/lib/ngrokapi/services/edge_route_backend_module_client.rb +8 -8
  404. data/lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb +8 -8
  405. data/lib/ngrokapi/services/edge_route_compression_module_client.rb +8 -8
  406. data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +8 -8
  407. data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +8 -8
  408. data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +8 -8
  409. data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +8 -8
  410. data/lib/ngrokapi/services/edge_route_response_headers_module_client.rb +8 -8
  411. data/lib/ngrokapi/services/edge_route_saml_module_client.rb +8 -8
  412. data/lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb +8 -8
  413. data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +8 -8
  414. data/lib/ngrokapi/services/edges_https_client.rb +37 -11
  415. data/lib/ngrokapi/services/edges_https_routes_client.rb +55 -5
  416. data/lib/ngrokapi/services/edges_tcp_client.rb +37 -11
  417. data/lib/ngrokapi/services/edges_tls_client.rb +41 -11
  418. data/lib/ngrokapi/services/endpoints_client.rb +8 -8
  419. data/lib/ngrokapi/services/event_destinations_client.rb +37 -13
  420. data/lib/ngrokapi/services/event_sources_client.rb +29 -7
  421. data/lib/ngrokapi/services/event_subscriptions_client.rb +35 -11
  422. data/lib/ngrokapi/services/failover_backends_client.rb +35 -13
  423. data/lib/ngrokapi/services/http_response_backends_client.rb +34 -11
  424. data/lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb +8 -8
  425. data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +8 -8
  426. data/lib/ngrokapi/services/ip_policies_client.rb +32 -11
  427. data/lib/ngrokapi/services/ip_policy_rules_client.rb +38 -12
  428. data/lib/ngrokapi/services/ip_restrictions_client.rb +37 -11
  429. data/lib/ngrokapi/services/reserved_addrs_client.rb +33 -11
  430. data/lib/ngrokapi/services/reserved_domains_client.rb +44 -16
  431. data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +37 -11
  432. data/lib/ngrokapi/services/ssh_credentials_client.rb +44 -15
  433. data/lib/ngrokapi/services/ssh_host_certificates_client.rb +41 -11
  434. data/lib/ngrokapi/services/ssh_user_certificates_client.rb +48 -14
  435. data/lib/ngrokapi/services/tcp_edge_backend_module_client.rb +8 -8
  436. data/lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb +8 -8
  437. data/lib/ngrokapi/services/tls_certificates_client.rb +37 -13
  438. data/lib/ngrokapi/services/tls_edge_backend_module_client.rb +8 -8
  439. data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +8 -8
  440. data/lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb +8 -8
  441. data/lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb +8 -8
  442. data/lib/ngrokapi/services/tunnel_group_backends_client.rb +35 -13
  443. data/lib/ngrokapi/services/tunnel_sessions_client.rb +8 -8
  444. data/lib/ngrokapi/services/tunnels_client.rb +8 -8
  445. data/lib/ngrokapi/services/weighted_backends_client.rb +38 -16
  446. data/lib/ngrokapi/version.rb +9 -7
  447. data/lib/ngrokapi.rb +15 -13
  448. data/ngrok-api.gemspec +29 -27
  449. data/spec/ngrokapi/client_spec.rb +20 -6
  450. data/spec/ngrokapi/http_client_spec.rb +77 -75
  451. data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +4 -2
  452. data/spec/ngrokapi/models/abuse_report_spec.rb +4 -2
  453. data/spec/ngrokapi/models/agent_ingress_cert_job_spec.rb +23 -0
  454. data/spec/ngrokapi/models/agent_ingress_cert_policy_spec.rb +23 -0
  455. data/spec/ngrokapi/models/agent_ingress_cert_status_spec.rb +23 -0
  456. data/spec/ngrokapi/models/agent_ingress_spec.rb +8 -3
  457. data/spec/ngrokapi/models/api_key_spec.rb +4 -2
  458. data/spec/ngrokapi/models/application_session_spec.rb +30 -0
  459. data/spec/ngrokapi/models/application_user_spec.rb +30 -0
  460. data/spec/ngrokapi/models/aws_auth_spec.rb +4 -2
  461. data/spec/ngrokapi/models/aws_credentials_spec.rb +4 -2
  462. data/spec/ngrokapi/models/aws_role_spec.rb +4 -2
  463. data/spec/ngrokapi/models/browser_session_spec.rb +23 -0
  464. data/spec/ngrokapi/models/certificate_authority_spec.rb +4 -2
  465. data/spec/ngrokapi/models/credential_spec.rb +4 -2
  466. data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +4 -2
  467. data/spec/ngrokapi/models/endpoint_backend_spec.rb +4 -2
  468. data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +4 -2
  469. data/spec/ngrokapi/models/endpoint_compression_spec.rb +4 -2
  470. data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +4 -2
  471. data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +4 -2
  472. data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +4 -2
  473. data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +4 -2
  474. data/spec/ngrokapi/models/endpoint_o_auth_amazon_spec.rb +23 -0
  475. data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +4 -2
  476. data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +4 -2
  477. data/spec/ngrokapi/models/endpoint_o_auth_git_lab_spec.rb +23 -0
  478. data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +4 -2
  479. data/spec/ngrokapi/models/endpoint_o_auth_linked_in_spec.rb +23 -0
  480. data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +4 -2
  481. data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +4 -2
  482. data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +4 -2
  483. data/spec/ngrokapi/models/endpoint_o_auth_twitch_spec.rb +23 -0
  484. data/spec/ngrokapi/models/endpoint_oidc_spec.rb +4 -2
  485. data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +4 -2
  486. data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +4 -2
  487. data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +4 -2
  488. data/spec/ngrokapi/models/endpoint_saml_spec.rb +4 -2
  489. data/spec/ngrokapi/models/endpoint_spec.rb +4 -2
  490. data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +4 -2
  491. data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +4 -2
  492. data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +4 -2
  493. data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +4 -2
  494. data/spec/ngrokapi/models/event_destination_spec.rb +4 -2
  495. data/spec/ngrokapi/models/event_source_list_spec.rb +4 -2
  496. data/spec/ngrokapi/models/event_source_replace_spec.rb +4 -2
  497. data/spec/ngrokapi/models/event_source_spec.rb +4 -2
  498. data/spec/ngrokapi/models/event_subscription_spec.rb +4 -2
  499. data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +4 -2
  500. data/spec/ngrokapi/models/event_target_datadog_spec.rb +23 -0
  501. data/spec/ngrokapi/models/event_target_firehose_spec.rb +4 -2
  502. data/spec/ngrokapi/models/event_target_kinesis_spec.rb +4 -2
  503. data/spec/ngrokapi/models/event_target_spec.rb +4 -2
  504. data/spec/ngrokapi/models/failover_backend_spec.rb +4 -2
  505. data/spec/ngrokapi/models/http_response_backend_spec.rb +4 -2
  506. data/spec/ngrokapi/models/https_edge_route_spec.rb +4 -2
  507. data/spec/ngrokapi/models/https_edge_spec.rb +4 -2
  508. data/spec/ngrokapi/models/identity_provider_spec.rb +23 -0
  509. data/spec/ngrokapi/models/ip_policy_rule_spec.rb +4 -2
  510. data/spec/ngrokapi/models/ip_policy_spec.rb +4 -2
  511. data/spec/ngrokapi/models/ip_restriction_spec.rb +4 -2
  512. data/spec/ngrokapi/models/listable_spec.rb +45 -43
  513. data/spec/ngrokapi/models/location_spec.rb +23 -0
  514. data/spec/ngrokapi/models/ref_spec.rb +4 -2
  515. data/spec/ngrokapi/models/reserved_addr_spec.rb +4 -2
  516. data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +4 -2
  517. data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +4 -2
  518. data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +4 -2
  519. data/spec/ngrokapi/models/reserved_domain_spec.rb +4 -2
  520. data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +4 -2
  521. data/spec/ngrokapi/models/ssh_credential_spec.rb +4 -2
  522. data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +4 -2
  523. data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +4 -2
  524. data/spec/ngrokapi/models/tcp_edge_spec.rb +4 -2
  525. data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +4 -2
  526. data/spec/ngrokapi/models/tls_certificate_spec.rb +4 -2
  527. data/spec/ngrokapi/models/tls_edge_spec.rb +4 -2
  528. data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +4 -2
  529. data/spec/ngrokapi/models/tunnel_session_spec.rb +4 -2
  530. data/spec/ngrokapi/models/tunnel_spec.rb +4 -2
  531. data/spec/ngrokapi/models/user_agent_spec.rb +23 -0
  532. data/spec/ngrokapi/models/weighted_backend_spec.rb +4 -2
  533. data/spec/ngrokapi/paged_iterator_spec.rb +86 -84
  534. data/spec/ngrokapi/services/abuse_reports_client_spec.rb +21 -0
  535. data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +34 -3
  536. data/spec/ngrokapi/services/api_keys_client_spec.rb +28 -1
  537. data/spec/ngrokapi/services/application_sessions_client_spec.rb +100 -0
  538. data/spec/ngrokapi/services/application_users_client_spec.rb +100 -0
  539. data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +23 -0
  540. data/spec/ngrokapi/services/credentials_client_spec.rb +30 -1
  541. data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +4 -4
  542. data/spec/ngrokapi/services/edge_route_circuit_breaker_module_client_spec.rb +4 -4
  543. data/spec/ngrokapi/services/edge_route_compression_module_client_spec.rb +4 -4
  544. data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +4 -4
  545. data/spec/ngrokapi/services/edge_route_o_auth_module_client_spec.rb +4 -4
  546. data/spec/ngrokapi/services/edge_route_oidc_module_client_spec.rb +4 -4
  547. data/spec/ngrokapi/services/edge_route_request_headers_module_client_spec.rb +4 -4
  548. data/spec/ngrokapi/services/edge_route_response_headers_module_client_spec.rb +4 -4
  549. data/spec/ngrokapi/services/edge_route_saml_module_client_spec.rb +4 -4
  550. data/spec/ngrokapi/services/edge_route_webhook_verification_module_client_spec.rb +4 -4
  551. data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +4 -4
  552. data/spec/ngrokapi/services/edges_https_client_spec.rb +27 -0
  553. data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +49 -0
  554. data/spec/ngrokapi/services/edges_tcp_client_spec.rb +27 -0
  555. data/spec/ngrokapi/services/edges_tls_client_spec.rb +31 -0
  556. data/spec/ngrokapi/services/endpoints_client_spec.rb +2 -0
  557. data/spec/ngrokapi/services/event_destinations_client_spec.rb +26 -0
  558. data/spec/ngrokapi/services/event_sources_client_spec.rb +23 -0
  559. data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +25 -0
  560. data/spec/ngrokapi/services/failover_backends_client_spec.rb +23 -0
  561. data/spec/ngrokapi/services/http_response_backends_client_spec.rb +27 -0
  562. data/spec/ngrokapi/services/https_edge_mutual_tls_module_client_spec.rb +4 -4
  563. data/spec/ngrokapi/services/https_edge_tls_termination_module_client_spec.rb +4 -4
  564. data/spec/ngrokapi/services/ip_policies_client_spec.rb +22 -0
  565. data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +27 -0
  566. data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +27 -0
  567. data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +24 -0
  568. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +38 -3
  569. data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +27 -0
  570. data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +32 -1
  571. data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +31 -0
  572. data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +35 -0
  573. data/spec/ngrokapi/services/tcp_edge_backend_module_client_spec.rb +4 -4
  574. data/spec/ngrokapi/services/tcp_edge_ip_restriction_module_client_spec.rb +4 -4
  575. data/spec/ngrokapi/services/tls_certificates_client_spec.rb +25 -0
  576. data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +4 -4
  577. data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +4 -4
  578. data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +4 -4
  579. data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +4 -4
  580. data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +23 -0
  581. data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +2 -0
  582. data/spec/ngrokapi/services/tunnels_client_spec.rb +2 -0
  583. data/spec/ngrokapi/services/weighted_backends_client_spec.rb +23 -0
  584. data/spec/spec_helper.rb +94 -2
  585. metadata +68 -4
  586. data/doc/README +0 -94
  587. data/docs/README +0 -94
data/doc/index.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  File: README
8
8
 
9
- &mdash; Documentation by YARD 0.9.27
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
@@ -57,8 +57,8 @@
57
57
  <div class="clear"></div>
58
58
  </div>
59
59
 
60
- <div id="content"><div id='filecontents'>
61
- <h1 id="label-ngrok-api">ngrok-api</h1>
60
+ <div id="content"><div id='filecontents'><!-- Code generated for API Clients. DO NOT EDIT. -->
61
+ <h1 id="label-ngrok+API+client+library+for+Ruby">ngrok API client library for Ruby</h1>
62
62
 
63
63
  <p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it easier to consume in Ruby.</p>
64
64
 
@@ -69,6 +69,14 @@
69
69
  <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ngrok'>ngrok</span><span class='op'>-</span><span class='id identifier rubyid_api'>api</span>
70
70
  </code></pre>
71
71
 
72
+ <h2 id="label-Support">Support</h2>
73
+
74
+ <p>The best place to get support using this library is through the <a href="https://ngrok.com/slack">ngrok Slack Community</a>. If you find any bugs, please contribute by opening a <a href="https://github.com/ngrok/ngrok-api-ruby/issues/new/choose">new GitHub issue</a>.</p>
75
+
76
+ <h2 id="label-Documentation">Documentation</h2>
77
+
78
+ <p>A quickstart guide and a full API reference are included in the <a href="https://ruby-api.docs.ngrok.com">ngrok Ruby API documentation</a></p>
79
+
72
80
  <h2 id="label-Quickstart">Quickstart</h2>
73
81
 
74
82
  <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p>
@@ -79,73 +87,69 @@
79
87
  <span class='comment'># Get an instance of the api_keys client and list all API keys
80
88
  </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
81
89
  <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
82
- </code></pre>
83
-
84
- <h2 id="label-Automatic+Paging">Automatic Paging</h2>
85
90
 
86
- <p>The ngrok API pages all list resources but this library abstracts that away from you. All response objects from any <code>list</code> or <code>list!</code> methods return an object that implements an <code>each</code> method which will automatically fetch additional pages for you.</p>
87
-
88
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
89
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
90
-
91
- <span class='comment'># list all api keys, transparently fetching additional
92
- </span><span class='comment'># pages for you if necessary
93
- </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
94
- <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span>
95
- <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
96
- <span class='kw'>end</span>
91
+ <span class='comment'># Or set up an edge and backend with the ability to change your configuration later
92
+ </span><span class='id identifier rubyid_edge'>edge</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https'>https</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
93
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A Ruby Created Edge</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
94
+ <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{&quot;client&quot;: &quot;ruby&quot;}</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
95
+ <span class='label'>hostports:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>your-subdomain.ngrok.io:443</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
96
+ <span class='rparen'>)</span>
97
+
98
+ <span class='id identifier rubyid_backend'>backend</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_backends'>backends</span><span class='period'>.</span><span class='id identifier rubyid_tunnel_group'>tunnel_group</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
99
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A Ruby Created Backend</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
100
+ <span class='label'>labels:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>client_example</span><span class='label_end'>&quot;:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ruby</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span>
101
+ <span class='rparen'>)</span>
102
+
103
+ <span class='id identifier rubyid_route'>route</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https_routes'>https_routes</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
104
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
105
+ <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>path_prefix</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
106
+ <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
107
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Root</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
108
+ <span class='label'>backend:</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="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html" title="NgrokAPI::Models::EndpointBackendMutate (class)">EndpointBackendMutate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointBackendMutate#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>backend_id</span><span class='label_end'>&quot;:</span> <span class='id identifier rubyid_backend'>backend</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='comma'>,</span>
109
+ <span class='label'>compression:</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="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='rbrace'>}</span><span class='rparen'>)</span>
110
+ <span class='rparen'>)</span>
111
+
112
+ <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edge_modules'>edge_modules</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_compression'>https_edge_route_compression</span><span class='period'>.</span><span class='id identifier rubyid_replace!'>replace!</span><span class='lparen'>(</span>
113
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
114
+ <span class='label'>id:</span> <span class='id identifier rubyid_route'>route</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
115
+ <span class='label'>a_module:</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="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>false</span><span class='rbrace'>}</span><span class='rparen'>)</span>
116
+ <span class='rparen'>)</span>
97
117
  </code></pre>
98
118
 
99
- <h2 id="label-Instance+Methods">Instance Methods</h2>
119
+ <h2 id="label-Local+Documentation">Local Documentation</h2>
100
120
 
101
- <p>Instance methods like <code>update</code> and <code>delete</code> can be invoked on an instance of an API object itself as well as directly without needing to first fetch the object.</p>
121
+ <p>Documentation can be generated with the command:</p>
102
122
 
103
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
104
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
105
-
106
- <span class='comment'># update the metadata of a credential
107
- </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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'>&#39;</span><span class='tstring_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
108
- <span class='id identifier rubyid_cred'>cred</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
109
-
110
- <span class='comment'># or do it in single call
111
- </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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'>&#39;</span><span class='tstring_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
123
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_yard'>yard</span> <span class='id identifier rubyid_doc'>doc</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib/**/*.rb</span><span class='tstring_end'>&#39;</span></span>
112
124
  </code></pre>
113
125
 
114
- <h2 id="label-Bang+Methods">Bang Methods</h2>
115
-
116
- <p>Most methods that interact with the API have a <code>!</code> counterpart. It raises an error when one is returned by the API.</p>
126
+ <p>This will generate documentation which can be viewed within the doc folder.</p>
117
127
 
118
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
119
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
128
+ <h2 id="label-Specs">Specs</h2>
120
129
 
121
- <span class='comment'># no error raised, even though it&#39;s a bad identifier
122
- </span><span class='comment'># the error is simply returned
123
- </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
130
+ <p>Specs can be run with the command:</p>
124
131
 
125
- <span class='comment'># this raises an NgrokAPI::Error
126
- </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
132
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span>
127
133
  </code></pre>
128
134
 
129
- <h2 id="label-Error+Handling">Error Handling</h2>
135
+ <p>This will generate a coverage report which can be viewed within the coverage folder.</p>
130
136
 
131
- <p>The ngrok API returns detailed information when an API call fails. Consult the section on errors for additional details.</p>
137
+ <h2 id="label-Rubocop">Rubocop</h2>
132
138
 
133
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
134
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
139
+ <p>Rubocop can be run with the command:</p>
140
+
141
+ <pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder
142
+ </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib</span><span class='tstring_end'>&#39;</span></span>
135
143
 
136
- <span class='kw'>begin</span>
137
- <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_ip_policies'>ip_policies</span><span class='period'>.</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'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
138
- <span class='kw'>rescue</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="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
139
- <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
140
- <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
141
- <span class='kw'>end</span>
144
+ <span class='comment'># Run rubcop on all files
145
+ </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span>
142
146
  </code></pre>
143
147
  </div></div>
144
148
 
145
149
  <div id="footer">
146
- Generated on Thu Mar 10 16:54:38 2022 by
147
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
148
- 0.9.27 (ruby-2.7.5).
150
+ Generated on Thu Aug 24 20:57:26 2023 by
151
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
152
+ 0.9.34 (ruby-3.0.6).
149
153
  </div>
150
154
 
151
155
  </div>