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
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: NgrokAPI::Services::APIKeysClient
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
 
@@ -207,7 +207,31 @@
207
207
  <li class="public ">
208
208
  <span class="summary_signature">
209
209
 
210
- <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;) &#x21d2; NgrokAPI::Models::APIKey </a>
210
+ <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, owner_id: nil, owner_email: &quot;&quot;) &#x21d2; NgrokAPI::Models::APIKey </a>
211
+
212
+
213
+
214
+ </span>
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+ <span class="summary_desc"><div class='inline'>
225
+ <p>Create a new API key.</p>
226
+ </div></span>
227
+
228
+ </li>
229
+
230
+
231
+ <li class="public ">
232
+ <span class="summary_signature">
233
+
234
+ <a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(description: &quot;&quot;, metadata: &quot;&quot;, owner_id: nil, owner_email: &quot;&quot;) &#x21d2; NgrokAPI::Models::APIKey </a>
211
235
 
212
236
 
213
237
 
@@ -478,12 +502,12 @@
478
502
  <pre class="lines">
479
503
 
480
504
 
481
- 21
482
- 22
483
- 23</pre>
505
+ 23
506
+ 24
507
+ 25</pre>
484
508
  </td>
485
509
  <td>
486
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 21</span>
510
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 23</span>
487
511
 
488
512
  <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
489
513
  <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
@@ -526,12 +550,12 @@
526
550
  <pre class="lines">
527
551
 
528
552
 
529
- 19
530
- 20
531
- 21</pre>
553
+ 21
554
+ 22
555
+ 23</pre>
532
556
  </td>
533
557
  <td>
534
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 19</span>
558
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 21</span>
535
559
 
536
560
  <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
537
561
  <span class='ivar'>@client</span>
@@ -551,7 +575,7 @@
551
575
  <div class="method_details first">
552
576
  <h3 class="signature first" id="create-instance_method">
553
577
 
554
- #<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>
578
+ #<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, owner_id: nil, owner_email: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>
555
579
 
556
580
 
557
581
 
@@ -603,6 +627,24 @@
603
627
  &mdash;
604
628
  <div class='inline'>
605
629
  <p>arbitrary user-defined data of this API key. optional, max 4096 bytes</p>
630
+ </div>
631
+
632
+ </li>
633
+
634
+ <li>
635
+
636
+ <span class='name'>owner_id</span>
637
+
638
+
639
+ <span class='type'>(<tt>string</tt>)</span>
640
+
641
+
642
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
643
+
644
+
645
+ &mdash;
646
+ <div class='inline'>
647
+ <p>If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p>
606
648
  </div>
607
649
 
608
650
  </li>
@@ -634,29 +676,166 @@
634
676
  <pre class="lines">
635
677
 
636
678
 
637
- 34
638
- 35
639
- 36
640
679
  37
641
680
  38
642
681
  39
643
682
  40
644
683
  41
645
684
  42
646
- 43</pre>
685
+ 43
686
+ 44
687
+ 45
688
+ 46
689
+ 47</pre>
647
690
  </td>
648
691
  <td>
649
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 34</span>
692
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 37</span>
650
693
 
651
- <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
694
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>owner_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>owner_email:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
652
695
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api_keys</span><span class='tstring_end'>&#39;</span></span>
653
696
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
654
697
  <span class='rbrace'>}</span>
655
698
  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
656
699
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
657
700
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
701
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:owner_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_owner_id'>owner_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_owner_id'>owner_id</span>
658
702
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
659
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
703
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
704
+ <span class='kw'>end</span></pre>
705
+ </td>
706
+ </tr>
707
+ </table>
708
+ </div>
709
+
710
+ <div class="method_details ">
711
+ <h3 class="signature " id="create!-instance_method">
712
+
713
+ #<strong>create!</strong>(description: &quot;&quot;, metadata: &quot;&quot;, owner_id: nil, owner_email: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>
714
+
715
+
716
+
717
+
718
+
719
+ </h3><div class="docstring">
720
+ <div class="discussion">
721
+
722
+ <p>Create a new API key. The generated API key can be used to authenticate to the ngrok API. Throws an exception if API error.</p>
723
+
724
+ <p><a href="https://ngrok.com/docs/api#api-api-keys-create">ngrok.com/docs/api#api-api-keys-create</a></p>
725
+
726
+
727
+ </div>
728
+ </div>
729
+ <div class="tags">
730
+ <p class="tag_title">Parameters:</p>
731
+ <ul class="param">
732
+
733
+ <li>
734
+
735
+ <span class='name'>description</span>
736
+
737
+
738
+ <span class='type'>(<tt>string</tt>)</span>
739
+
740
+
741
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
742
+
743
+
744
+ &mdash;
745
+ <div class='inline'>
746
+ <p>human-readable description of what uses the API key to authenticate. optional, max 255 bytes.</p>
747
+ </div>
748
+
749
+ </li>
750
+
751
+ <li>
752
+
753
+ <span class='name'>metadata</span>
754
+
755
+
756
+ <span class='type'>(<tt>string</tt>)</span>
757
+
758
+
759
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
760
+
761
+
762
+ &mdash;
763
+ <div class='inline'>
764
+ <p>arbitrary user-defined data of this API key. optional, max 4096 bytes</p>
765
+ </div>
766
+
767
+ </li>
768
+
769
+ <li>
770
+
771
+ <span class='name'>owner_id</span>
772
+
773
+
774
+ <span class='type'>(<tt>string</tt>)</span>
775
+
776
+
777
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
778
+
779
+
780
+ &mdash;
781
+ <div class='inline'>
782
+ <p>If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p>
783
+ </div>
784
+
785
+ </li>
786
+
787
+ </ul>
788
+
789
+ <p class="tag_title">Returns:</p>
790
+ <ul class="return">
791
+
792
+ <li>
793
+
794
+
795
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>)</span>
796
+
797
+
798
+
799
+ &mdash;
800
+ <div class='inline'>
801
+ <p>result from the API request</p>
802
+ </div>
803
+
804
+ </li>
805
+
806
+ </ul>
807
+
808
+ </div><table class="source_code">
809
+ <tr>
810
+ <td>
811
+ <pre class="lines">
812
+
813
+
814
+ 60
815
+ 61
816
+ 62
817
+ 63
818
+ 64
819
+ 65
820
+ 66
821
+ 67
822
+ 68
823
+ 69
824
+ 70</pre>
825
+ </td>
826
+ <td>
827
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 60</span>
828
+
829
+ <span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>owner_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>owner_email:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
830
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api_keys</span><span class='tstring_end'>&#39;</span></span>
831
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
832
+ <span class='rbrace'>}</span>
833
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
834
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
835
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
836
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:owner_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_owner_id'>owner_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_owner_id'>owner_id</span>
837
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
838
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
660
839
  <span class='kw'>end</span></pre>
661
840
  </td>
662
841
  </tr>
@@ -731,16 +910,16 @@
731
910
  <pre class="lines">
732
911
 
733
912
 
734
- 52
735
- 53
736
- 54
737
- 55
738
- 56
739
- 57
740
- 58</pre>
913
+ 79
914
+ 80
915
+ 81
916
+ 82
917
+ 83
918
+ 84
919
+ 85</pre>
741
920
  </td>
742
921
  <td>
743
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 52</span>
922
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 79</span>
744
923
 
745
924
  <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
746
925
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -822,16 +1001,16 @@
822
1001
  <pre class="lines">
823
1002
 
824
1003
 
825
- 68
826
- 69
827
- 70
828
- 71
829
- 72
830
- 73
831
- 74</pre>
1004
+ 95
1005
+ 96
1006
+ 97
1007
+ 98
1008
+ 99
1009
+ 100
1010
+ 101</pre>
832
1011
  </td>
833
1012
  <td>
834
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 68</span>
1013
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 95</span>
835
1014
 
836
1015
  <span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
837
1016
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -913,18 +1092,18 @@
913
1092
  <pre class="lines">
914
1093
 
915
1094
 
916
- 83
917
- 84
918
- 85
919
- 86
920
- 87
921
- 88
922
- 89
923
- 90
924
- 91</pre>
1095
+ 110
1096
+ 111
1097
+ 112
1098
+ 113
1099
+ 114
1100
+ 115
1101
+ 116
1102
+ 117
1103
+ 118</pre>
925
1104
  </td>
926
1105
  <td>
927
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 83</span>
1106
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 110</span>
928
1107
 
929
1108
  <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
930
1109
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -933,7 +1112,7 @@
933
1112
  <span class='rbrace'>}</span>
934
1113
  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
935
1114
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
936
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1115
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
937
1116
  <span class='kw'>end</span></pre>
938
1117
  </td>
939
1118
  </tr>
@@ -1008,18 +1187,18 @@
1008
1187
  <pre class="lines">
1009
1188
 
1010
1189
 
1011
- 101
1012
- 102
1013
- 103
1014
- 104
1015
- 105
1016
- 106
1017
- 107
1018
- 108
1019
- 109</pre>
1190
+ 128
1191
+ 129
1192
+ 130
1193
+ 131
1194
+ 132
1195
+ 133
1196
+ 134
1197
+ 135
1198
+ 136</pre>
1020
1199
  </td>
1021
1200
  <td>
1022
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 101</span>
1201
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 128</span>
1023
1202
 
1024
1203
  <span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1025
1204
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1028,7 +1207,7 @@
1028
1207
  <span class='rbrace'>}</span>
1029
1208
  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1030
1209
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
1031
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1210
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1032
1211
  <span class='kw'>end</span></pre>
1033
1212
  </td>
1034
1213
  </tr>
@@ -1129,28 +1308,26 @@
1129
1308
  <pre class="lines">
1130
1309
 
1131
1310
 
1132
- 120
1133
- 121
1134
- 122
1135
- 123
1136
- 124
1137
- 125
1138
- 126
1139
- 127
1140
- 128
1141
- 129
1142
- 130
1143
- 131
1144
- 132
1145
- 133
1146
- 134
1147
- 135</pre>
1311
+ 147
1312
+ 148
1313
+ 149
1314
+ 150
1315
+ 151
1316
+ 152
1317
+ 153
1318
+ 154
1319
+ 155
1320
+ 156
1321
+ 157
1322
+ 158
1323
+ 159
1324
+ 160
1325
+ 161</pre>
1148
1326
  </td>
1149
1327
  <td>
1150
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 120</span>
1328
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 147</span>
1151
1329
 
1152
- <span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1153
- <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1330
+ <span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1154
1331
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1155
1332
  <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1156
1333
  <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
@@ -1160,7 +1337,7 @@
1160
1337
 
1161
1338
  <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1162
1339
  <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1163
- <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1340
+ <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1164
1341
  <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::APIKeysClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1165
1342
  <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span>
1166
1343
  <span class='rparen'>)</span>
@@ -1264,30 +1441,28 @@
1264
1441
  <pre class="lines">
1265
1442
 
1266
1443
 
1267
- 147
1268
- 148
1269
- 149
1270
- 150
1271
- 151
1272
- 152
1273
- 153
1274
- 154
1275
- 155
1276
- 156
1277
- 157
1278
- 158
1279
- 159
1280
- 160
1281
- 161
1282
- 162
1283
- 163
1284
- 164</pre>
1444
+ 173
1445
+ 174
1446
+ 175
1447
+ 176
1448
+ 177
1449
+ 178
1450
+ 179
1451
+ 180
1452
+ 181
1453
+ 182
1454
+ 183
1455
+ 184
1456
+ 185
1457
+ 186
1458
+ 187
1459
+ 188
1460
+ 189</pre>
1285
1461
  </td>
1286
1462
  <td>
1287
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 147</span>
1463
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 173</span>
1288
1464
 
1289
- <span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1290
- <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1465
+ <span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1291
1466
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1292
1467
  <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1293
1468
  <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
@@ -1298,7 +1473,7 @@
1298
1473
 
1299
1474
  <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1300
1475
  <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1301
- <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1476
+ <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1302
1477
  <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::APIKeysClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1303
1478
  <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='comma'>,</span>
1304
1479
  <span class='label'>danger:</span> <span class='kw'>true</span>
@@ -1408,20 +1583,20 @@
1408
1583
  <pre class="lines">
1409
1584
 
1410
1585
 
1411
- 175
1412
- 176
1413
- 177
1414
- 178
1415
- 179
1416
- 180
1417
- 181
1418
- 182
1419
- 183
1420
- 184
1421
- 185</pre>
1586
+ 200
1587
+ 201
1588
+ 202
1589
+ 203
1590
+ 204
1591
+ 205
1592
+ 206
1593
+ 207
1594
+ 208
1595
+ 209
1596
+ 210</pre>
1422
1597
  </td>
1423
1598
  <td>
1424
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 175</span>
1599
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 200</span>
1425
1600
 
1426
1601
  <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1427
1602
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1432,7 +1607,7 @@
1432
1607
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
1433
1608
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
1434
1609
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1435
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1610
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1436
1611
  <span class='kw'>end</span></pre>
1437
1612
  </td>
1438
1613
  </tr>
@@ -1538,20 +1713,20 @@
1538
1713
  <pre class="lines">
1539
1714
 
1540
1715
 
1541
- 197
1542
- 198
1543
- 199
1544
- 200
1545
- 201
1546
- 202
1547
- 203
1548
- 204
1549
- 205
1550
- 206
1551
- 207</pre>
1716
+ 222
1717
+ 223
1718
+ 224
1719
+ 225
1720
+ 226
1721
+ 227
1722
+ 228
1723
+ 229
1724
+ 230
1725
+ 231
1726
+ 232</pre>
1552
1727
  </td>
1553
1728
  <td>
1554
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 197</span>
1729
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 222</span>
1555
1730
 
1556
1731
  <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1557
1732
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1562,7 +1737,7 @@
1562
1737
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
1563
1738
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
1564
1739
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
1565
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1740
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1566
1741
  <span class='kw'>end</span></pre>
1567
1742
  </td>
1568
1743
  </tr>
@@ -1574,9 +1749,9 @@
1574
1749
  </div>
1575
1750
 
1576
1751
  <div id="footer">
1577
- Generated on Thu Mar 10 16:54:41 2022 by
1578
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1579
- 0.9.27 (ruby-2.7.5).
1752
+ Generated on Thu Aug 24 20:57:30 2023 by
1753
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1754
+ 0.9.34 (ruby-3.0.6).
1580
1755
  </div>
1581
1756
 
1582
1757
  </div>