ngrok-api 0.19.0 → 0.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (585) 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 -88
  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 +73 -73
  18. data/doc/NgrokAPI/Models/APIKey.html +150 -72
  19. data/doc/NgrokAPI/Models/AWSAuth.html +36 -36
  20. data/doc/NgrokAPI/Models/AWSCredentials.html +36 -36
  21. data/doc/NgrokAPI/Models/AWSRole.html +32 -32
  22. data/doc/NgrokAPI/Models/AbuseReport.html +63 -59
  23. data/doc/NgrokAPI/Models/AbuseReportHostname.html +36 -36
  24. data/doc/NgrokAPI/Models/AgentIngress.html +245 -87
  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 +93 -89
  32. data/doc/NgrokAPI/Models/Credential.html +154 -76
  33. data/doc/NgrokAPI/Models/Endpoint.html +87 -83
  34. data/doc/NgrokAPI/Models/EndpointBackend.html +36 -36
  35. data/doc/NgrokAPI/Models/EndpointBackendMutate.html +36 -36
  36. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +52 -52
  37. data/doc/NgrokAPI/Models/EndpointCompression.html +32 -32
  38. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +36 -36
  39. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +36 -36
  40. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +36 -36
  41. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +36 -36
  42. data/doc/NgrokAPI/Models/EndpointOAuth.html +56 -56
  43. data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +891 -0
  44. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +48 -48
  45. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +56 -56
  46. data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +891 -0
  47. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +48 -48
  48. data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +891 -0
  49. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +48 -48
  50. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +345 -49
  51. data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +891 -0
  52. data/doc/NgrokAPI/Models/EndpointOIDC.html +64 -64
  53. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +40 -40
  54. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +40 -40
  55. data/doc/NgrokAPI/Models/EndpointSAML.html +114 -98
  56. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +79 -75
  57. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +40 -40
  58. data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +36 -36
  59. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +40 -40
  60. data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +32 -32
  61. data/doc/NgrokAPI/Models/EventDestination.html +69 -65
  62. data/doc/NgrokAPI/Models/EventSource.html +51 -47
  63. data/doc/NgrokAPI/Models/EventSourceList.html +43 -39
  64. data/doc/NgrokAPI/Models/EventSourceReplace.html +40 -40
  65. data/doc/NgrokAPI/Models/EventSubscription.html +69 -65
  66. data/doc/NgrokAPI/Models/EventTarget.html +119 -45
  67. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +36 -36
  68. data/doc/NgrokAPI/Models/EventTargetDatadog.html +817 -0
  69. data/doc/NgrokAPI/Models/EventTargetFirehose.html +36 -36
  70. data/doc/NgrokAPI/Models/EventTargetKinesis.html +36 -36
  71. data/doc/NgrokAPI/Models/FailoverBackend.html +73 -69
  72. data/doc/NgrokAPI/Models/HTTPResponseBackend.html +81 -77
  73. data/doc/NgrokAPI/Models/HTTPSEdge.html +85 -81
  74. data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +127 -123
  75. data/doc/NgrokAPI/Models/IPPolicy.html +73 -69
  76. data/doc/NgrokAPI/Models/IPPolicyRule.html +81 -77
  77. data/doc/NgrokAPI/Models/IPRestriction.html +73 -69
  78. data/doc/NgrokAPI/Models/IdentityProvider.html +669 -0
  79. data/doc/NgrokAPI/Models/Listable.html +79 -79
  80. data/doc/NgrokAPI/Models/Location.html +817 -0
  81. data/doc/NgrokAPI/Models/Ref.html +43 -39
  82. data/doc/NgrokAPI/Models/ReservedAddr.html +73 -69
  83. data/doc/NgrokAPI/Models/ReservedDomain.html +97 -93
  84. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +44 -44
  85. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +36 -36
  86. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +36 -36
  87. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +77 -73
  88. data/doc/NgrokAPI/Models/SSHCredential.html +154 -76
  89. data/doc/NgrokAPI/Models/SSHHostCertificate.html +97 -93
  90. data/doc/NgrokAPI/Models/SSHUserCertificate.html +105 -101
  91. data/doc/NgrokAPI/Models/TCPEdge.html +81 -77
  92. data/doc/NgrokAPI/Models/TLSCertificate.html +133 -129
  93. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +36 -36
  94. data/doc/NgrokAPI/Models/TLSEdge.html +89 -85
  95. data/doc/NgrokAPI/Models/Tunnel.html +79 -75
  96. data/doc/NgrokAPI/Models/TunnelGroupBackend.html +77 -73
  97. data/doc/NgrokAPI/Models/TunnelSession.html +75 -71
  98. data/doc/NgrokAPI/Models/UserAgent.html +965 -0
  99. data/doc/NgrokAPI/Models/WeightedBackend.html +73 -69
  100. data/doc/NgrokAPI/Models.html +6 -6
  101. data/doc/NgrokAPI/PagedIterator.html +53 -53
  102. data/doc/NgrokAPI/Services/APIKeysClient.html +134 -94
  103. data/doc/NgrokAPI/Services/AbuseReportsClient.html +28 -28
  104. data/doc/NgrokAPI/Services/AgentIngressesClient.html +184 -104
  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 +52 -52
  108. data/doc/NgrokAPI/Services/CredentialsClient.html +139 -99
  109. data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +36 -36
  110. data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +36 -36
  111. data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +36 -36
  112. data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +36 -36
  113. data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +36 -36
  114. data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +36 -36
  115. data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +36 -36
  116. data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +36 -36
  117. data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +36 -36
  118. data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +36 -36
  119. data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +36 -36
  120. data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +52 -52
  121. data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +44 -44
  122. data/doc/NgrokAPI/Services/EdgesTCPClient.html +52 -52
  123. data/doc/NgrokAPI/Services/EdgesTLSClient.html +52 -52
  124. data/doc/NgrokAPI/Services/EndpointsClient.html +28 -28
  125. data/doc/NgrokAPI/Services/EventDestinationsClient.html +17 -17
  126. data/doc/NgrokAPI/Services/EventSourcesClient.html +52 -52
  127. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +52 -52
  128. data/doc/NgrokAPI/Services/FailoverBackendsClient.html +52 -52
  129. data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +52 -52
  130. data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +36 -36
  131. data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +36 -36
  132. data/doc/NgrokAPI/Services/IPPoliciesClient.html +52 -52
  133. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +58 -62
  134. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +52 -52
  135. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +52 -52
  136. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +90 -86
  137. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +52 -52
  138. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +138 -98
  139. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +52 -52
  140. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +56 -56
  141. data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +36 -36
  142. data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +36 -36
  143. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +56 -56
  144. data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +36 -36
  145. data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +36 -36
  146. data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +36 -36
  147. data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +36 -36
  148. data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +52 -52
  149. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +52 -52
  150. data/doc/NgrokAPI/Services/TunnelsClient.html +28 -28
  151. data/doc/NgrokAPI/Services/WeightedBackendsClient.html +52 -52
  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 +45 -41
  157. data/doc/frames.html +1 -1
  158. data/doc/index.html +45 -41
  159. data/doc/method_list.html +2127 -671
  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 +73 -73
  166. data/docs/NgrokAPI/Models/APIKey.html +150 -72
  167. data/docs/NgrokAPI/Models/AWSAuth.html +36 -36
  168. data/docs/NgrokAPI/Models/AWSCredentials.html +36 -36
  169. data/docs/NgrokAPI/Models/AWSRole.html +32 -32
  170. data/docs/NgrokAPI/Models/AbuseReport.html +63 -59
  171. data/docs/NgrokAPI/Models/AbuseReportHostname.html +36 -36
  172. data/docs/NgrokAPI/Models/AgentIngress.html +245 -87
  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 +93 -89
  180. data/docs/NgrokAPI/Models/Credential.html +154 -76
  181. data/docs/NgrokAPI/Models/Endpoint.html +87 -83
  182. data/docs/NgrokAPI/Models/EndpointBackend.html +36 -36
  183. data/docs/NgrokAPI/Models/EndpointBackendMutate.html +36 -36
  184. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +52 -52
  185. data/docs/NgrokAPI/Models/EndpointCompression.html +32 -32
  186. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +36 -36
  187. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +36 -36
  188. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +36 -36
  189. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +36 -36
  190. data/docs/NgrokAPI/Models/EndpointOAuth.html +56 -56
  191. data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +891 -0
  192. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +48 -48
  193. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +56 -56
  194. data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +891 -0
  195. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +48 -48
  196. data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +891 -0
  197. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +48 -48
  198. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +345 -49
  199. data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +891 -0
  200. data/docs/NgrokAPI/Models/EndpointOIDC.html +64 -64
  201. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +40 -40
  202. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +40 -40
  203. data/docs/NgrokAPI/Models/EndpointSAML.html +114 -98
  204. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +79 -75
  205. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +40 -40
  206. data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +36 -36
  207. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +40 -40
  208. data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +32 -32
  209. data/docs/NgrokAPI/Models/EventDestination.html +69 -65
  210. data/docs/NgrokAPI/Models/EventSource.html +51 -47
  211. data/docs/NgrokAPI/Models/EventSourceList.html +43 -39
  212. data/docs/NgrokAPI/Models/EventSourceReplace.html +40 -40
  213. data/docs/NgrokAPI/Models/EventSubscription.html +69 -65
  214. data/docs/NgrokAPI/Models/EventTarget.html +119 -45
  215. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +36 -36
  216. data/docs/NgrokAPI/Models/EventTargetDatadog.html +817 -0
  217. data/docs/NgrokAPI/Models/EventTargetFirehose.html +36 -36
  218. data/docs/NgrokAPI/Models/EventTargetKinesis.html +36 -36
  219. data/docs/NgrokAPI/Models/FailoverBackend.html +73 -69
  220. data/docs/NgrokAPI/Models/HTTPResponseBackend.html +81 -77
  221. data/docs/NgrokAPI/Models/HTTPSEdge.html +85 -81
  222. data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +127 -123
  223. data/docs/NgrokAPI/Models/IPPolicy.html +73 -69
  224. data/docs/NgrokAPI/Models/IPPolicyRule.html +81 -77
  225. data/docs/NgrokAPI/Models/IPRestriction.html +73 -69
  226. data/docs/NgrokAPI/Models/IdentityProvider.html +669 -0
  227. data/docs/NgrokAPI/Models/Listable.html +79 -79
  228. data/docs/NgrokAPI/Models/Location.html +817 -0
  229. data/docs/NgrokAPI/Models/Ref.html +43 -39
  230. data/docs/NgrokAPI/Models/ReservedAddr.html +73 -69
  231. data/docs/NgrokAPI/Models/ReservedDomain.html +97 -93
  232. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +44 -44
  233. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +36 -36
  234. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +36 -36
  235. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +77 -73
  236. data/docs/NgrokAPI/Models/SSHCredential.html +154 -76
  237. data/docs/NgrokAPI/Models/SSHHostCertificate.html +97 -93
  238. data/docs/NgrokAPI/Models/SSHUserCertificate.html +105 -101
  239. data/docs/NgrokAPI/Models/TCPEdge.html +81 -77
  240. data/docs/NgrokAPI/Models/TLSCertificate.html +133 -129
  241. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +36 -36
  242. data/docs/NgrokAPI/Models/TLSEdge.html +89 -85
  243. data/docs/NgrokAPI/Models/Tunnel.html +79 -75
  244. data/docs/NgrokAPI/Models/TunnelGroupBackend.html +77 -73
  245. data/docs/NgrokAPI/Models/TunnelSession.html +75 -71
  246. data/docs/NgrokAPI/Models/UserAgent.html +965 -0
  247. data/docs/NgrokAPI/Models/WeightedBackend.html +73 -69
  248. data/docs/NgrokAPI/Models.html +6 -6
  249. data/docs/NgrokAPI/PagedIterator.html +53 -53
  250. data/docs/NgrokAPI/Services/APIKeysClient.html +134 -94
  251. data/docs/NgrokAPI/Services/AbuseReportsClient.html +28 -28
  252. data/docs/NgrokAPI/Services/AgentIngressesClient.html +184 -104
  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 +52 -52
  256. data/docs/NgrokAPI/Services/CredentialsClient.html +139 -99
  257. data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +36 -36
  258. data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +36 -36
  259. data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +36 -36
  260. data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +36 -36
  261. data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +36 -36
  262. data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +36 -36
  263. data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +36 -36
  264. data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +36 -36
  265. data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +36 -36
  266. data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +36 -36
  267. data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +36 -36
  268. data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +52 -52
  269. data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +44 -44
  270. data/docs/NgrokAPI/Services/EdgesTCPClient.html +52 -52
  271. data/docs/NgrokAPI/Services/EdgesTLSClient.html +52 -52
  272. data/docs/NgrokAPI/Services/EndpointsClient.html +28 -28
  273. data/docs/NgrokAPI/Services/EventDestinationsClient.html +17 -17
  274. data/docs/NgrokAPI/Services/EventSourcesClient.html +52 -52
  275. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +52 -52
  276. data/docs/NgrokAPI/Services/FailoverBackendsClient.html +52 -52
  277. data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +52 -52
  278. data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +36 -36
  279. data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +36 -36
  280. data/docs/NgrokAPI/Services/IPPoliciesClient.html +52 -52
  281. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +58 -62
  282. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +52 -52
  283. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +52 -52
  284. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +90 -86
  285. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +52 -52
  286. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +138 -98
  287. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +52 -52
  288. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +56 -56
  289. data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +36 -36
  290. data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +36 -36
  291. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +56 -56
  292. data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +36 -36
  293. data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +36 -36
  294. data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +36 -36
  295. data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +36 -36
  296. data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +52 -52
  297. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +52 -52
  298. data/docs/NgrokAPI/Services/TunnelsClient.html +28 -28
  299. data/docs/NgrokAPI/Services/WeightedBackendsClient.html +52 -52
  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 +45 -41
  305. data/docs/frames.html +1 -1
  306. data/docs/index.html +45 -41
  307. data/docs/method_list.html +2127 -671
  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 -150
  313. data/lib/ngrokapi/models/abuse_report.rb +7 -1
  314. data/lib/ngrokapi/models/abuse_report_hostname.rb +2 -0
  315. data/lib/ngrokapi/models/agent_ingress.rb +17 -4
  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 +10 -2
  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 +2 -0
  323. data/lib/ngrokapi/models/aws_credentials.rb +2 -0
  324. data/lib/ngrokapi/models/aws_role.rb +2 -0
  325. data/lib/ngrokapi/models/browser_session.rb +35 -0
  326. data/lib/ngrokapi/models/certificate_authority.rb +7 -1
  327. data/lib/ngrokapi/models/credential.rb +10 -2
  328. data/lib/ngrokapi/models/endpoint.rb +7 -1
  329. data/lib/ngrokapi/models/endpoint_backend.rb +2 -0
  330. data/lib/ngrokapi/models/endpoint_backend_mutate.rb +2 -0
  331. data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +2 -0
  332. data/lib/ngrokapi/models/endpoint_compression.rb +2 -0
  333. data/lib/ngrokapi/models/endpoint_ip_policy.rb +2 -0
  334. data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +2 -0
  335. data/lib/ngrokapi/models/endpoint_mutual_tls.rb +2 -0
  336. data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +2 -0
  337. data/lib/ngrokapi/models/endpoint_o_auth.rb +2 -0
  338. data/lib/ngrokapi/models/endpoint_o_auth_amazon.rb +39 -0
  339. data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +2 -0
  340. data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +2 -0
  341. data/lib/ngrokapi/models/endpoint_o_auth_git_lab.rb +39 -0
  342. data/lib/ngrokapi/models/endpoint_o_auth_google.rb +2 -0
  343. data/lib/ngrokapi/models/endpoint_o_auth_linked_in.rb +39 -0
  344. data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +2 -0
  345. data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +11 -1
  346. data/lib/ngrokapi/models/endpoint_o_auth_twitch.rb +39 -0
  347. data/lib/ngrokapi/models/endpoint_oidc.rb +2 -0
  348. data/lib/ngrokapi/models/endpoint_request_headers.rb +2 -0
  349. data/lib/ngrokapi/models/endpoint_response_headers.rb +2 -0
  350. data/lib/ngrokapi/models/endpoint_saml.rb +16 -4
  351. data/lib/ngrokapi/models/endpoint_saml_mutate.rb +7 -1
  352. data/lib/ngrokapi/models/endpoint_tls_termination.rb +2 -0
  353. data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +2 -0
  354. data/lib/ngrokapi/models/endpoint_webhook_validation.rb +2 -0
  355. data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +2 -0
  356. data/lib/ngrokapi/models/event_destination.rb +7 -1
  357. data/lib/ngrokapi/models/event_source.rb +7 -1
  358. data/lib/ngrokapi/models/event_source_list.rb +7 -1
  359. data/lib/ngrokapi/models/event_source_replace.rb +2 -0
  360. data/lib/ngrokapi/models/event_subscription.rb +7 -1
  361. data/lib/ngrokapi/models/event_target.rb +5 -1
  362. data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +2 -0
  363. data/lib/ngrokapi/models/event_target_datadog.rb +37 -0
  364. data/lib/ngrokapi/models/event_target_firehose.rb +2 -0
  365. data/lib/ngrokapi/models/event_target_kinesis.rb +2 -0
  366. data/lib/ngrokapi/models/failover_backend.rb +7 -1
  367. data/lib/ngrokapi/models/http_response_backend.rb +7 -1
  368. data/lib/ngrokapi/models/https_edge.rb +7 -1
  369. data/lib/ngrokapi/models/https_edge_route.rb +7 -1
  370. data/lib/ngrokapi/models/identity_provider.rb +33 -0
  371. data/lib/ngrokapi/models/ip_policy.rb +7 -1
  372. data/lib/ngrokapi/models/ip_policy_rule.rb +7 -1
  373. data/lib/ngrokapi/models/ip_restriction.rb +7 -1
  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 +7 -1
  377. data/lib/ngrokapi/models/reserved_addr.rb +7 -1
  378. data/lib/ngrokapi/models/reserved_domain.rb +7 -1
  379. data/lib/ngrokapi/models/reserved_domain_cert_job.rb +2 -0
  380. data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +2 -0
  381. data/lib/ngrokapi/models/reserved_domain_cert_status.rb +2 -0
  382. data/lib/ngrokapi/models/ssh_certificate_authority.rb +7 -1
  383. data/lib/ngrokapi/models/ssh_credential.rb +10 -2
  384. data/lib/ngrokapi/models/ssh_host_certificate.rb +7 -1
  385. data/lib/ngrokapi/models/ssh_user_certificate.rb +7 -1
  386. data/lib/ngrokapi/models/tcp_edge.rb +7 -1
  387. data/lib/ngrokapi/models/tls_certificate.rb +7 -1
  388. data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +2 -0
  389. data/lib/ngrokapi/models/tls_edge.rb +7 -1
  390. data/lib/ngrokapi/models/tunnel.rb +7 -1
  391. data/lib/ngrokapi/models/tunnel_group_backend.rb +7 -1
  392. data/lib/ngrokapi/models/tunnel_session.rb +7 -1
  393. data/lib/ngrokapi/models/user_agent.rb +41 -0
  394. data/lib/ngrokapi/models/weighted_backend.rb +7 -1
  395. data/lib/ngrokapi/paged_iterator.rb +44 -42
  396. data/lib/ngrokapi/services/abuse_reports_client.rb +2 -0
  397. data/lib/ngrokapi/services/agent_ingresses_client.rb +14 -4
  398. data/lib/ngrokapi/services/api_keys_client.rb +8 -2
  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 +2 -0
  402. data/lib/ngrokapi/services/credentials_client.rb +13 -7
  403. data/lib/ngrokapi/services/edge_route_backend_module_client.rb +2 -0
  404. data/lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb +2 -0
  405. data/lib/ngrokapi/services/edge_route_compression_module_client.rb +2 -0
  406. data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +2 -0
  407. data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +2 -0
  408. data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +2 -0
  409. data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +2 -0
  410. data/lib/ngrokapi/services/edge_route_response_headers_module_client.rb +2 -0
  411. data/lib/ngrokapi/services/edge_route_saml_module_client.rb +2 -0
  412. data/lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb +2 -0
  413. data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +2 -0
  414. data/lib/ngrokapi/services/edges_https_client.rb +2 -0
  415. data/lib/ngrokapi/services/edges_https_routes_client.rb +2 -0
  416. data/lib/ngrokapi/services/edges_tcp_client.rb +2 -0
  417. data/lib/ngrokapi/services/edges_tls_client.rb +2 -0
  418. data/lib/ngrokapi/services/endpoints_client.rb +2 -0
  419. data/lib/ngrokapi/services/event_destinations_client.rb +4 -4
  420. data/lib/ngrokapi/services/event_sources_client.rb +2 -0
  421. data/lib/ngrokapi/services/event_subscriptions_client.rb +2 -0
  422. data/lib/ngrokapi/services/failover_backends_client.rb +2 -0
  423. data/lib/ngrokapi/services/http_response_backends_client.rb +2 -0
  424. data/lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb +2 -0
  425. data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +2 -0
  426. data/lib/ngrokapi/services/ip_policies_client.rb +2 -0
  427. data/lib/ngrokapi/services/ip_policy_rules_client.rb +4 -2
  428. data/lib/ngrokapi/services/ip_restrictions_client.rb +2 -0
  429. data/lib/ngrokapi/services/reserved_addrs_client.rb +2 -0
  430. data/lib/ngrokapi/services/reserved_domains_client.rb +10 -8
  431. data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +2 -0
  432. data/lib/ngrokapi/services/ssh_credentials_client.rb +12 -6
  433. data/lib/ngrokapi/services/ssh_host_certificates_client.rb +2 -0
  434. data/lib/ngrokapi/services/ssh_user_certificates_client.rb +6 -4
  435. data/lib/ngrokapi/services/tcp_edge_backend_module_client.rb +2 -0
  436. data/lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb +2 -0
  437. data/lib/ngrokapi/services/tls_certificates_client.rb +6 -4
  438. data/lib/ngrokapi/services/tls_edge_backend_module_client.rb +2 -0
  439. data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +2 -0
  440. data/lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb +2 -0
  441. data/lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb +2 -0
  442. data/lib/ngrokapi/services/tunnel_group_backends_client.rb +2 -0
  443. data/lib/ngrokapi/services/tunnel_sessions_client.rb +2 -0
  444. data/lib/ngrokapi/services/tunnels_client.rb +2 -0
  445. data/lib/ngrokapi/services/weighted_backends_client.rb +2 -0
  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 +2 -0
  452. data/spec/ngrokapi/models/abuse_report_spec.rb +2 -0
  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 +6 -1
  457. data/spec/ngrokapi/models/api_key_spec.rb +2 -0
  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 +2 -0
  461. data/spec/ngrokapi/models/aws_credentials_spec.rb +2 -0
  462. data/spec/ngrokapi/models/aws_role_spec.rb +2 -0
  463. data/spec/ngrokapi/models/browser_session_spec.rb +23 -0
  464. data/spec/ngrokapi/models/certificate_authority_spec.rb +2 -0
  465. data/spec/ngrokapi/models/credential_spec.rb +2 -0
  466. data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +2 -0
  467. data/spec/ngrokapi/models/endpoint_backend_spec.rb +2 -0
  468. data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +2 -0
  469. data/spec/ngrokapi/models/endpoint_compression_spec.rb +2 -0
  470. data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +2 -0
  471. data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +2 -0
  472. data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +2 -0
  473. data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +2 -0
  474. data/spec/ngrokapi/models/endpoint_o_auth_amazon_spec.rb +23 -0
  475. data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +2 -0
  476. data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +2 -0
  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 +2 -0
  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 +2 -0
  481. data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +2 -0
  482. data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +2 -0
  483. data/spec/ngrokapi/models/endpoint_o_auth_twitch_spec.rb +23 -0
  484. data/spec/ngrokapi/models/endpoint_oidc_spec.rb +2 -0
  485. data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +2 -0
  486. data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +2 -0
  487. data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +2 -0
  488. data/spec/ngrokapi/models/endpoint_saml_spec.rb +2 -0
  489. data/spec/ngrokapi/models/endpoint_spec.rb +2 -0
  490. data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +2 -0
  491. data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +2 -0
  492. data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +2 -0
  493. data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +2 -0
  494. data/spec/ngrokapi/models/event_destination_spec.rb +2 -0
  495. data/spec/ngrokapi/models/event_source_list_spec.rb +2 -0
  496. data/spec/ngrokapi/models/event_source_replace_spec.rb +2 -0
  497. data/spec/ngrokapi/models/event_source_spec.rb +2 -0
  498. data/spec/ngrokapi/models/event_subscription_spec.rb +2 -0
  499. data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +2 -0
  500. data/spec/ngrokapi/models/event_target_datadog_spec.rb +23 -0
  501. data/spec/ngrokapi/models/event_target_firehose_spec.rb +2 -0
  502. data/spec/ngrokapi/models/event_target_kinesis_spec.rb +2 -0
  503. data/spec/ngrokapi/models/event_target_spec.rb +2 -0
  504. data/spec/ngrokapi/models/failover_backend_spec.rb +2 -0
  505. data/spec/ngrokapi/models/http_response_backend_spec.rb +2 -0
  506. data/spec/ngrokapi/models/https_edge_route_spec.rb +2 -0
  507. data/spec/ngrokapi/models/https_edge_spec.rb +2 -0
  508. data/spec/ngrokapi/models/identity_provider_spec.rb +23 -0
  509. data/spec/ngrokapi/models/ip_policy_rule_spec.rb +2 -0
  510. data/spec/ngrokapi/models/ip_policy_spec.rb +2 -0
  511. data/spec/ngrokapi/models/ip_restriction_spec.rb +2 -0
  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 +2 -0
  515. data/spec/ngrokapi/models/reserved_addr_spec.rb +2 -0
  516. data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +2 -0
  517. data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +2 -0
  518. data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +2 -0
  519. data/spec/ngrokapi/models/reserved_domain_spec.rb +2 -0
  520. data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +2 -0
  521. data/spec/ngrokapi/models/ssh_credential_spec.rb +2 -0
  522. data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +2 -0
  523. data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +2 -0
  524. data/spec/ngrokapi/models/tcp_edge_spec.rb +2 -0
  525. data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +2 -0
  526. data/spec/ngrokapi/models/tls_certificate_spec.rb +2 -0
  527. data/spec/ngrokapi/models/tls_edge_spec.rb +2 -0
  528. data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +2 -0
  529. data/spec/ngrokapi/models/tunnel_session_spec.rb +2 -0
  530. data/spec/ngrokapi/models/tunnel_spec.rb +2 -0
  531. data/spec/ngrokapi/models/user_agent_spec.rb +23 -0
  532. data/spec/ngrokapi/models/weighted_backend_spec.rb +2 -0
  533. data/spec/ngrokapi/paged_iterator_spec.rb +86 -84
  534. data/spec/ngrokapi/services/abuse_reports_client_spec.rb +2 -0
  535. data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +14 -4
  536. data/spec/ngrokapi/services/api_keys_client_spec.rb +10 -2
  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 +2 -0
  540. data/spec/ngrokapi/services/credentials_client_spec.rb +10 -2
  541. data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +2 -0
  542. data/spec/ngrokapi/services/edge_route_circuit_breaker_module_client_spec.rb +2 -0
  543. data/spec/ngrokapi/services/edge_route_compression_module_client_spec.rb +2 -0
  544. data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +2 -0
  545. data/spec/ngrokapi/services/edge_route_o_auth_module_client_spec.rb +2 -0
  546. data/spec/ngrokapi/services/edge_route_oidc_module_client_spec.rb +2 -0
  547. data/spec/ngrokapi/services/edge_route_request_headers_module_client_spec.rb +2 -0
  548. data/spec/ngrokapi/services/edge_route_response_headers_module_client_spec.rb +2 -0
  549. data/spec/ngrokapi/services/edge_route_saml_module_client_spec.rb +2 -0
  550. data/spec/ngrokapi/services/edge_route_webhook_verification_module_client_spec.rb +2 -0
  551. data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +2 -0
  552. data/spec/ngrokapi/services/edges_https_client_spec.rb +2 -0
  553. data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +2 -0
  554. data/spec/ngrokapi/services/edges_tcp_client_spec.rb +2 -0
  555. data/spec/ngrokapi/services/edges_tls_client_spec.rb +2 -0
  556. data/spec/ngrokapi/services/endpoints_client_spec.rb +2 -0
  557. data/spec/ngrokapi/services/event_destinations_client_spec.rb +2 -0
  558. data/spec/ngrokapi/services/event_sources_client_spec.rb +2 -0
  559. data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +2 -0
  560. data/spec/ngrokapi/services/failover_backends_client_spec.rb +2 -0
  561. data/spec/ngrokapi/services/http_response_backends_client_spec.rb +2 -0
  562. data/spec/ngrokapi/services/https_edge_mutual_tls_module_client_spec.rb +2 -0
  563. data/spec/ngrokapi/services/https_edge_tls_termination_module_client_spec.rb +2 -0
  564. data/spec/ngrokapi/services/ip_policies_client_spec.rb +2 -0
  565. data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +2 -0
  566. data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +2 -0
  567. data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +2 -0
  568. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +10 -4
  569. data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +2 -0
  570. data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +10 -2
  571. data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +2 -0
  572. data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +2 -0
  573. data/spec/ngrokapi/services/tcp_edge_backend_module_client_spec.rb +2 -0
  574. data/spec/ngrokapi/services/tcp_edge_ip_restriction_module_client_spec.rb +2 -0
  575. data/spec/ngrokapi/services/tls_certificates_client_spec.rb +2 -0
  576. data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +2 -0
  577. data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +2 -0
  578. data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +2 -0
  579. data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +2 -0
  580. data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +2 -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 +2 -0
  584. data/spec/spec_helper.rb +94 -2
  585. metadata +68 -2
@@ -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,7 @@
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
211
 
212
212
 
213
213
 
@@ -231,7 +231,7 @@
231
231
  <li class="public ">
232
232
  <span class="summary_signature">
233
233
 
234
- <a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(description: &quot;&quot;, metadata: &quot;&quot;, acl: []) &#x21d2; NgrokAPI::Models::Credential </a>
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>
235
235
 
236
236
 
237
237
 
@@ -502,12 +502,12 @@
502
502
  <pre class="lines">
503
503
 
504
504
 
505
- 20
506
- 21
507
- 22</pre>
505
+ 22
506
+ 23
507
+ 24</pre>
508
508
  </td>
509
509
  <td>
510
- <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>
511
511
 
512
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>
513
513
  <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
@@ -550,12 +550,12 @@
550
550
  <pre class="lines">
551
551
 
552
552
 
553
- 18
554
- 19
555
- 20</pre>
553
+ 20
554
+ 21
555
+ 22</pre>
556
556
  </td>
557
557
  <td>
558
- <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>
559
559
 
560
560
  <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
561
561
  <span class='ivar'>@client</span>
@@ -575,7 +575,7 @@
575
575
  <div class="method_details first">
576
576
  <h3 class="signature first" id="create-instance_method">
577
577
 
578
- #<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>
579
579
 
580
580
 
581
581
 
@@ -644,7 +644,25 @@
644
644
 
645
645
  &mdash;
646
646
  <div class='inline'>
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 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>
648
666
  </div>
649
667
 
650
668
  </li>
@@ -676,9 +694,6 @@
676
694
  <pre class="lines">
677
695
 
678
696
 
679
- 36
680
- 37
681
- 38
682
697
  39
683
698
  40
684
699
  41
@@ -686,12 +701,16 @@
686
701
  43
687
702
  44
688
703
  45
689
- 46</pre>
704
+ 46
705
+ 47
706
+ 48
707
+ 49
708
+ 50</pre>
690
709
  </td>
691
710
  <td>
692
- <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>
693
712
 
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'>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>
695
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>
696
715
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
697
716
  <span class='rbrace'>}</span>
@@ -699,6 +718,7 @@
699
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>
700
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>
701
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>
702
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>
703
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>
704
724
  <span class='kw'>end</span></pre>
@@ -710,7 +730,7 @@
710
730
  <div class="method_details ">
711
731
  <h3 class="signature " id="create!-instance_method">
712
732
 
713
- #<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>
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>
714
734
 
715
735
 
716
736
 
@@ -779,7 +799,25 @@
779
799
 
780
800
  &mdash;
781
801
  <div class='inline'>
782
- <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>
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>
783
821
  </div>
784
822
 
785
823
  </li>
@@ -811,22 +849,23 @@
811
849
  <pre class="lines">
812
850
 
813
851
 
814
- 61
815
- 62
816
- 63
817
- 64
818
- 65
819
852
  66
820
853
  67
821
854
  68
822
855
  69
823
856
  70
824
- 71</pre>
857
+ 71
858
+ 72
859
+ 73
860
+ 74
861
+ 75
862
+ 76
863
+ 77</pre>
825
864
  </td>
826
865
  <td>
827
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 61</span>
866
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 66</span>
828
867
 
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'>acl:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
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>
830
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>
831
870
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
832
871
  <span class='rbrace'>}</span>
@@ -834,6 +873,7 @@
834
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>
835
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>
836
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>
837
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>
838
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>
839
879
  <span class='kw'>end</span></pre>
@@ -910,16 +950,16 @@
910
950
  <pre class="lines">
911
951
 
912
952
 
913
- 80
914
- 81
915
- 82
916
- 83
917
- 84
918
- 85
919
- 86</pre>
953
+ 86
954
+ 87
955
+ 88
956
+ 89
957
+ 90
958
+ 91
959
+ 92</pre>
920
960
  </td>
921
961
  <td>
922
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 80</span>
962
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 86</span>
923
963
 
924
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>
925
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>
@@ -1001,16 +1041,16 @@
1001
1041
  <pre class="lines">
1002
1042
 
1003
1043
 
1004
- 96
1005
- 97
1006
- 98
1007
- 99
1008
- 100
1009
- 101
1010
- 102</pre>
1044
+ 102
1045
+ 103
1046
+ 104
1047
+ 105
1048
+ 106
1049
+ 107
1050
+ 108</pre>
1011
1051
  </td>
1012
1052
  <td>
1013
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 96</span>
1053
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 102</span>
1014
1054
 
1015
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>
1016
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>
@@ -1092,18 +1132,18 @@
1092
1132
  <pre class="lines">
1093
1133
 
1094
1134
 
1095
- 111
1096
- 112
1097
- 113
1098
- 114
1099
- 115
1100
- 116
1101
1135
  117
1102
1136
  118
1103
- 119</pre>
1137
+ 119
1138
+ 120
1139
+ 121
1140
+ 122
1141
+ 123
1142
+ 124
1143
+ 125</pre>
1104
1144
  </td>
1105
1145
  <td>
1106
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 111</span>
1146
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 117</span>
1107
1147
 
1108
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>
1109
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>
@@ -1187,18 +1227,18 @@
1187
1227
  <pre class="lines">
1188
1228
 
1189
1229
 
1190
- 129
1191
- 130
1192
- 131
1193
- 132
1194
- 133
1195
- 134
1196
1230
  135
1197
1231
  136
1198
- 137</pre>
1232
+ 137
1233
+ 138
1234
+ 139
1235
+ 140
1236
+ 141
1237
+ 142
1238
+ 143</pre>
1199
1239
  </td>
1200
1240
  <td>
1201
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 129</span>
1241
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 135</span>
1202
1242
 
1203
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>
1204
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>
@@ -1308,12 +1348,6 @@
1308
1348
  <pre class="lines">
1309
1349
 
1310
1350
 
1311
- 148
1312
- 149
1313
- 150
1314
- 151
1315
- 152
1316
- 153
1317
1351
  154
1318
1352
  155
1319
1353
  156
@@ -1322,10 +1356,16 @@
1322
1356
  159
1323
1357
  160
1324
1358
  161
1325
- 162</pre>
1359
+ 162
1360
+ 163
1361
+ 164
1362
+ 165
1363
+ 166
1364
+ 167
1365
+ 168</pre>
1326
1366
  </td>
1327
1367
  <td>
1328
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 148</span>
1368
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 154</span>
1329
1369
 
1330
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>
1331
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>
@@ -1441,12 +1481,6 @@
1441
1481
  <pre class="lines">
1442
1482
 
1443
1483
 
1444
- 174
1445
- 175
1446
- 176
1447
- 177
1448
- 178
1449
- 179
1450
1484
  180
1451
1485
  181
1452
1486
  182
@@ -1457,10 +1491,16 @@
1457
1491
  187
1458
1492
  188
1459
1493
  189
1460
- 190</pre>
1494
+ 190
1495
+ 191
1496
+ 192
1497
+ 193
1498
+ 194
1499
+ 195
1500
+ 196</pre>
1461
1501
  </td>
1462
1502
  <td>
1463
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 174</span>
1503
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 180</span>
1464
1504
 
1465
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>
1466
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>
@@ -1569,7 +1609,7 @@
1569
1609
 
1570
1610
  &mdash;
1571
1611
  <div class='inline'>
1572
- <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>
1573
1613
  </div>
1574
1614
 
1575
1615
  </li>
@@ -1601,21 +1641,21 @@
1601
1641
  <pre class="lines">
1602
1642
 
1603
1643
 
1604
- 202
1605
- 203
1606
- 204
1607
- 205
1608
- 206
1609
- 207
1610
1644
  208
1611
1645
  209
1612
1646
  210
1613
1647
  211
1614
1648
  212
1615
- 213</pre>
1649
+ 213
1650
+ 214
1651
+ 215
1652
+ 216
1653
+ 217
1654
+ 218
1655
+ 219</pre>
1616
1656
  </td>
1617
1657
  <td>
1618
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 202</span>
1658
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 208</span>
1619
1659
 
1620
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>
1621
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>
@@ -1719,7 +1759,7 @@
1719
1759
 
1720
1760
  &mdash;
1721
1761
  <div class='inline'>
1722
- <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>
1723
1763
  </div>
1724
1764
 
1725
1765
  </li>
@@ -1751,21 +1791,21 @@
1751
1791
  <pre class="lines">
1752
1792
 
1753
1793
 
1754
- 226
1755
- 227
1756
- 228
1757
- 229
1758
- 230
1759
- 231
1760
1794
  232
1761
1795
  233
1762
1796
  234
1763
1797
  235
1764
1798
  236
1765
- 237</pre>
1799
+ 237
1800
+ 238
1801
+ 239
1802
+ 240
1803
+ 241
1804
+ 242
1805
+ 243</pre>
1766
1806
  </td>
1767
1807
  <td>
1768
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 226</span>
1808
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 232</span>
1769
1809
 
1770
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>
1771
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>
@@ -1789,9 +1829,9 @@
1789
1829
  </div>
1790
1830
 
1791
1831
  <div id="footer">
1792
- Generated on Mon Apr 11 19:32:59 2022 by
1793
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1794
- 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).
1795
1835
  </div>
1796
1836
 
1797
1837
  </div>