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::CredentialsClient
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
 
@@ -102,7 +102,7 @@
102
102
  <h2>Overview</h2><div class="docstring">
103
103
  <div class="discussion">
104
104
 
105
- <p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the <code>ngrok authtoken</code> command or by specifying it in the <code>ngrok.yml</code> configuration file with the <code>authtoken</code> property.</p>
105
+ <p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the <code>ngrok config add-authtoken</code> command or by specifying it in the <code>ngrok.yml</code> configuration file with the <code>authtoken</code> property.</p>
106
106
 
107
107
  <p><a href="https://ngrok.com/docs/api#api-credentials">ngrok.com/docs/api#api-credentials</a></p>
108
108
 
@@ -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;, acl: []) &#x21d2; NgrokAPI::Models::Credential </a>
210
+ <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, acl: [], owner_id: nil, owner_email: &quot;&quot;) &#x21d2; NgrokAPI::Models::Credential </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 tunnel authtoken credential.</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;, acl: [], owner_id: nil, owner_email: &quot;&quot;) &#x21d2; NgrokAPI::Models::Credential </a>
211
235
 
212
236
 
213
237
 
@@ -478,12 +502,12 @@
478
502
  <pre class="lines">
479
503
 
480
504
 
481
- 20
482
- 21
483
- 22</pre>
505
+ 22
506
+ 23
507
+ 24</pre>
484
508
  </td>
485
509
  <td>
486
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 20</span>
510
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 22</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
- 18
530
- 19
531
- 20</pre>
553
+ 20
554
+ 21
555
+ 22</pre>
532
556
  </td>
533
557
  <td>
534
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 18</span>
558
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 20</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;, acl: []) &#x21d2; <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
578
+ #<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, acl: [], owner_id: nil, owner_email: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
555
579
 
556
580
 
557
581
 
@@ -620,7 +644,25 @@
620
644
 
621
645
  &mdash;
622
646
  <div class='inline'>
623
- <p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
647
+ <p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code>bind:*=example</code> which will allow <code>x=example</code>, <code>y=example</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
648
+ </div>
649
+
650
+ </li>
651
+
652
+ <li>
653
+
654
+ <span class='name'>owner_id</span>
655
+
656
+
657
+ <span class='type'>(<tt>string</tt>)</span>
658
+
659
+
660
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
661
+
662
+
663
+ &mdash;
664
+ <div class='inline'>
665
+ <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>
624
666
  </div>
625
667
 
626
668
  </li>
@@ -652,9 +694,6 @@
652
694
  <pre class="lines">
653
695
 
654
696
 
655
- 36
656
- 37
657
- 38
658
697
  39
659
698
  40
660
699
  41
@@ -662,12 +701,16 @@
662
701
  43
663
702
  44
664
703
  45
665
- 46</pre>
704
+ 46
705
+ 47
706
+ 48
707
+ 49
708
+ 50</pre>
666
709
  </td>
667
710
  <td>
668
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 36</span>
711
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 39</span>
669
712
 
670
- <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'>acl:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
713
+ <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'>acl:</span> <span class='lbracket'>[</span><span class='rbracket'>]</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>
671
714
  <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'>/credentials</span><span class='tstring_end'>&#39;</span></span>
672
715
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
673
716
  <span class='rbrace'>}</span>
@@ -675,8 +718,164 @@
675
718
  <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>
676
719
  <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>
677
720
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:acl</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_acl'>acl</span> <span class='kw'>if</span> <span class='id identifier rubyid_acl'>acl</span>
721
+ <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>
678
722
  <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>
679
- <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#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>
723
+ <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#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>
724
+ <span class='kw'>end</span></pre>
725
+ </td>
726
+ </tr>
727
+ </table>
728
+ </div>
729
+
730
+ <div class="method_details ">
731
+ <h3 class="signature " id="create!-instance_method">
732
+
733
+ #<strong>create!</strong>(description: &quot;&quot;, metadata: &quot;&quot;, acl: [], owner_id: nil, owner_email: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
734
+
735
+
736
+
737
+
738
+
739
+ </h3><div class="docstring">
740
+ <div class="discussion">
741
+
742
+ <p>Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself. Throws an exception if API error.</p>
743
+
744
+ <p><a href="https://ngrok.com/docs/api#api-credentials-create">ngrok.com/docs/api#api-credentials-create</a></p>
745
+
746
+
747
+ </div>
748
+ </div>
749
+ <div class="tags">
750
+ <p class="tag_title">Parameters:</p>
751
+ <ul class="param">
752
+
753
+ <li>
754
+
755
+ <span class='name'>description</span>
756
+
757
+
758
+ <span class='type'>(<tt>string</tt>)</span>
759
+
760
+
761
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
762
+
763
+
764
+ &mdash;
765
+ <div class='inline'>
766
+ <p>human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</p>
767
+ </div>
768
+
769
+ </li>
770
+
771
+ <li>
772
+
773
+ <span class='name'>metadata</span>
774
+
775
+
776
+ <span class='type'>(<tt>string</tt>)</span>
777
+
778
+
779
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
780
+
781
+
782
+ &mdash;
783
+ <div class='inline'>
784
+ <p>arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</p>
785
+ </div>
786
+
787
+ </li>
788
+
789
+ <li>
790
+
791
+ <span class='name'>acl</span>
792
+
793
+
794
+ <span class='type'>(<tt>List&lt;string&gt;</tt>)</span>
795
+
796
+
797
+ <em class="default">(defaults to: <tt>[]</tt>)</em>
798
+
799
+
800
+ &mdash;
801
+ <div class='inline'>
802
+ <p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code>bind:*=example</code> which will allow <code>x=example</code>, <code>y=example</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
803
+ </div>
804
+
805
+ </li>
806
+
807
+ <li>
808
+
809
+ <span class='name'>owner_id</span>
810
+
811
+
812
+ <span class='type'>(<tt>string</tt>)</span>
813
+
814
+
815
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
816
+
817
+
818
+ &mdash;
819
+ <div class='inline'>
820
+ <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>
821
+ </div>
822
+
823
+ </li>
824
+
825
+ </ul>
826
+
827
+ <p class="tag_title">Returns:</p>
828
+ <ul class="return">
829
+
830
+ <li>
831
+
832
+
833
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>)</span>
834
+
835
+
836
+
837
+ &mdash;
838
+ <div class='inline'>
839
+ <p>result from the API request</p>
840
+ </div>
841
+
842
+ </li>
843
+
844
+ </ul>
845
+
846
+ </div><table class="source_code">
847
+ <tr>
848
+ <td>
849
+ <pre class="lines">
850
+
851
+
852
+ 66
853
+ 67
854
+ 68
855
+ 69
856
+ 70
857
+ 71
858
+ 72
859
+ 73
860
+ 74
861
+ 75
862
+ 76
863
+ 77</pre>
864
+ </td>
865
+ <td>
866
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 66</span>
867
+
868
+ <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'>acl:</span> <span class='lbracket'>[</span><span class='rbracket'>]</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>
869
+ <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'>/credentials</span><span class='tstring_end'>&#39;</span></span>
870
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
871
+ <span class='rbrace'>}</span>
872
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
873
+ <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>
874
+ <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>
875
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:acl</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_acl'>acl</span> <span class='kw'>if</span> <span class='id identifier rubyid_acl'>acl</span>
876
+ <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>
877
+ <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>
878
+ <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#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>
680
879
  <span class='kw'>end</span></pre>
681
880
  </td>
682
881
  </tr>
@@ -751,16 +950,16 @@
751
950
  <pre class="lines">
752
951
 
753
952
 
754
- 55
755
- 56
756
- 57
757
- 58
758
- 59
759
- 60
760
- 61</pre>
953
+ 86
954
+ 87
955
+ 88
956
+ 89
957
+ 90
958
+ 91
959
+ 92</pre>
761
960
  </td>
762
961
  <td>
763
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 55</span>
962
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 86</span>
764
963
 
765
964
  <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>
766
965
  <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'>/credentials/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -842,16 +1041,16 @@
842
1041
  <pre class="lines">
843
1042
 
844
1043
 
845
- 71
846
- 72
847
- 73
848
- 74
849
- 75
850
- 76
851
- 77</pre>
1044
+ 102
1045
+ 103
1046
+ 104
1047
+ 105
1048
+ 106
1049
+ 107
1050
+ 108</pre>
852
1051
  </td>
853
1052
  <td>
854
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 71</span>
1053
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 102</span>
855
1054
 
856
1055
  <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>
857
1056
  <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'>/credentials/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -933,18 +1132,18 @@
933
1132
  <pre class="lines">
934
1133
 
935
1134
 
936
- 86
937
- 87
938
- 88
939
- 89
940
- 90
941
- 91
942
- 92
943
- 93
944
- 94</pre>
1135
+ 117
1136
+ 118
1137
+ 119
1138
+ 120
1139
+ 121
1140
+ 122
1141
+ 123
1142
+ 124
1143
+ 125</pre>
945
1144
  </td>
946
1145
  <td>
947
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 86</span>
1146
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 117</span>
948
1147
 
949
1148
  <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>
950
1149
  <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'>/credentials/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -953,7 +1152,7 @@
953
1152
  <span class='rbrace'>}</span>
954
1153
  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
955
1154
  <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>
956
- <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#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>
1155
+ <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#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>
957
1156
  <span class='kw'>end</span></pre>
958
1157
  </td>
959
1158
  </tr>
@@ -1028,18 +1227,18 @@
1028
1227
  <pre class="lines">
1029
1228
 
1030
1229
 
1031
- 104
1032
- 105
1033
- 106
1034
- 107
1035
- 108
1036
- 109
1037
- 110
1038
- 111
1039
- 112</pre>
1230
+ 135
1231
+ 136
1232
+ 137
1233
+ 138
1234
+ 139
1235
+ 140
1236
+ 141
1237
+ 142
1238
+ 143</pre>
1040
1239
  </td>
1041
1240
  <td>
1042
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 104</span>
1241
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 135</span>
1043
1242
 
1044
1243
  <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>
1045
1244
  <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'>/credentials/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1048,7 +1247,7 @@
1048
1247
  <span class='rbrace'>}</span>
1049
1248
  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1050
1249
  <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>
1051
- <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#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>
1250
+ <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#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>
1052
1251
  <span class='kw'>end</span></pre>
1053
1252
  </td>
1054
1253
  </tr>
@@ -1149,28 +1348,26 @@
1149
1348
  <pre class="lines">
1150
1349
 
1151
1350
 
1152
- 123
1153
- 124
1154
- 125
1155
- 126
1156
- 127
1157
- 128
1158
- 129
1159
- 130
1160
- 131
1161
- 132
1162
- 133
1163
- 134
1164
- 135
1165
- 136
1166
- 137
1167
- 138</pre>
1351
+ 154
1352
+ 155
1353
+ 156
1354
+ 157
1355
+ 158
1356
+ 159
1357
+ 160
1358
+ 161
1359
+ 162
1360
+ 163
1361
+ 164
1362
+ 165
1363
+ 166
1364
+ 167
1365
+ 168</pre>
1168
1366
  </td>
1169
1367
  <td>
1170
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 123</span>
1368
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 154</span>
1171
1369
 
1172
- <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>
1173
- <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1370
+ <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>
1174
1371
  <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>
1175
1372
  <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1176
1373
  <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
@@ -1180,7 +1377,7 @@
1180
1377
 
1181
1378
  <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>
1182
1379
  <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1183
- <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1380
+ <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1184
1381
  <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::CredentialsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1185
1382
  <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span>
1186
1383
  <span class='rparen'>)</span>
@@ -1284,30 +1481,28 @@
1284
1481
  <pre class="lines">
1285
1482
 
1286
1483
 
1287
- 150
1288
- 151
1289
- 152
1290
- 153
1291
- 154
1292
- 155
1293
- 156
1294
- 157
1295
- 158
1296
- 159
1297
- 160
1298
- 161
1299
- 162
1300
- 163
1301
- 164
1302
- 165
1303
- 166
1304
- 167</pre>
1484
+ 180
1485
+ 181
1486
+ 182
1487
+ 183
1488
+ 184
1489
+ 185
1490
+ 186
1491
+ 187
1492
+ 188
1493
+ 189
1494
+ 190
1495
+ 191
1496
+ 192
1497
+ 193
1498
+ 194
1499
+ 195
1500
+ 196</pre>
1305
1501
  </td>
1306
1502
  <td>
1307
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 150</span>
1503
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 180</span>
1308
1504
 
1309
- <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>
1310
- <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1505
+ <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>
1311
1506
  <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>
1312
1507
  <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1313
1508
  <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
@@ -1318,7 +1513,7 @@
1318
1513
 
1319
1514
  <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>
1320
1515
  <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1321
- <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1516
+ <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1322
1517
  <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::CredentialsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1323
1518
  <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='comma'>,</span>
1324
1519
  <span class='label'>danger:</span> <span class='kw'>true</span>
@@ -1414,7 +1609,7 @@
1414
1609
 
1415
1610
  &mdash;
1416
1611
  <div class='inline'>
1417
- <p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
1612
+ <p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code>bind:*=example</code> which will allow <code>x=example</code>, <code>y=example</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
1418
1613
  </div>
1419
1614
 
1420
1615
  </li>
@@ -1446,21 +1641,21 @@
1446
1641
  <pre class="lines">
1447
1642
 
1448
1643
 
1449
- 179
1450
- 180
1451
- 181
1452
- 182
1453
- 183
1454
- 184
1455
- 185
1456
- 186
1457
- 187
1458
- 188
1459
- 189
1460
- 190</pre>
1644
+ 208
1645
+ 209
1646
+ 210
1647
+ 211
1648
+ 212
1649
+ 213
1650
+ 214
1651
+ 215
1652
+ 216
1653
+ 217
1654
+ 218
1655
+ 219</pre>
1461
1656
  </td>
1462
1657
  <td>
1463
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 179</span>
1658
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 208</span>
1464
1659
 
1465
1660
  <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>acl:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1466
1661
  <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'>/credentials/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1472,7 +1667,7 @@
1472
1667
  <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>
1473
1668
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:acl</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_acl'>acl</span> <span class='kw'>if</span> <span class='id identifier rubyid_acl'>acl</span>
1474
1669
  <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>
1475
- <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#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>
1670
+ <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#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>
1476
1671
  <span class='kw'>end</span></pre>
1477
1672
  </td>
1478
1673
  </tr>
@@ -1564,7 +1759,7 @@
1564
1759
 
1565
1760
  &mdash;
1566
1761
  <div class='inline'>
1567
- <p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
1762
+ <p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code>bind:*=example</code> which will allow <code>x=example</code>, <code>y=example</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
1568
1763
  </div>
1569
1764
 
1570
1765
  </li>
@@ -1596,21 +1791,21 @@
1596
1791
  <pre class="lines">
1597
1792
 
1598
1793
 
1599
- 203
1600
- 204
1601
- 205
1602
- 206
1603
- 207
1604
- 208
1605
- 209
1606
- 210
1607
- 211
1608
- 212
1609
- 213
1610
- 214</pre>
1794
+ 232
1795
+ 233
1796
+ 234
1797
+ 235
1798
+ 236
1799
+ 237
1800
+ 238
1801
+ 239
1802
+ 240
1803
+ 241
1804
+ 242
1805
+ 243</pre>
1611
1806
  </td>
1612
1807
  <td>
1613
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 203</span>
1808
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 232</span>
1614
1809
 
1615
1810
  <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>acl:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1616
1811
  <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'>/credentials/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1622,7 +1817,7 @@
1622
1817
  <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>
1623
1818
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:acl</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_acl'>acl</span> <span class='kw'>if</span> <span class='id identifier rubyid_acl'>acl</span>
1624
1819
  <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>
1625
- <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#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>
1820
+ <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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#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>
1626
1821
  <span class='kw'>end</span></pre>
1627
1822
  </td>
1628
1823
  </tr>
@@ -1634,9 +1829,9 @@
1634
1829
  </div>
1635
1830
 
1636
1831
  <div id="footer">
1637
- Generated on Thu Mar 10 16:54:42 2022 by
1638
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1639
- 0.9.27 (ruby-2.7.5).
1832
+ Generated on Thu Aug 24 20:57:31 2023 by
1833
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1834
+ 0.9.34 (ruby-3.0.6).
1640
1835
  </div>
1641
1836
 
1642
1837
  </div>