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
data/doc/file.README.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  File: README
8
8
 
9
- &mdash; Documentation by YARD 0.9.27
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
@@ -57,7 +57,7 @@
57
57
  <div class="clear"></div>
58
58
  </div>
59
59
 
60
- <div id="content"><div id='filecontents'>
60
+ <div id="content"><div id='filecontents'><!-- Code generated for API Clients. DO NOT EDIT. -->
61
61
  <h1 id="label-ngrok+API+client+library+for+Ruby">ngrok API client library for Ruby</h1>
62
62
 
63
63
  <p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it easier to consume in Ruby.</p>
@@ -69,6 +69,10 @@
69
69
  <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ngrok'>ngrok</span><span class='op'>-</span><span class='id identifier rubyid_api'>api</span>
70
70
  </code></pre>
71
71
 
72
+ <h2 id="label-Support">Support</h2>
73
+
74
+ <p>The best place to get support using this library is through the <a href="https://ngrok.com/slack">ngrok Slack Community</a>. If you find any bugs, please contribute by opening a <a href="https://github.com/ngrok/ngrok-api-ruby/issues/new/choose">new GitHub issue</a>.</p>
75
+
72
76
  <h2 id="label-Documentation">Documentation</h2>
73
77
 
74
78
  <p>A quickstart guide and a full API reference are included in the <a href="https://ruby-api.docs.ngrok.com">ngrok Ruby API documentation</a></p>
@@ -77,38 +81,38 @@
77
81
 
78
82
  <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p>
79
83
 
80
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
81
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
82
-
83
- <span class='comment'># Get an instance of the api_keys client and list all API keys
84
- </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
85
- <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
86
-
87
- <span class='comment'># Or set up an edge and backend with the ability to change your configuration later
88
- </span><span class='id identifier rubyid_edge'>edge</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https'>https</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
89
- <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A Ruby Created Edge</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
90
- <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{&quot;client&quot;: &quot;ruby&quot;}</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
91
- <span class='label'>hostports:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>your-subdomain.ngrok.io:443</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
92
- <span class='rparen'>)</span>
93
-
94
- <span class='id identifier rubyid_backend'>backend</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_backends'>backends</span><span class='period'>.</span><span class='id identifier rubyid_tunnel_group'>tunnel_group</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
95
- <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A Ruby Created Backend</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
96
- <span class='label'>labels:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>client_example</span><span class='label_end'>&quot;:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ruby</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span>
97
- <span class='rparen'>)</span>
98
-
99
- <span class='id identifier rubyid_route'>route</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https_routes'>https_routes</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
100
- <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
101
- <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>path_prefix</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
102
- <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
103
- <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Root</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
104
- <span class='label'>backend:</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html" title="NgrokAPI::Models::EndpointBackendMutate (class)">EndpointBackendMutate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointBackendMutate#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>backend_id</span><span class='label_end'>&quot;:</span> <span class='id identifier rubyid_backend'>backend</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='comma'>,</span>
105
- <span class='label'>compression:</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='rbrace'>}</span><span class='rparen'>)</span>
106
- <span class='rparen'>)</span>
107
-
108
- <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edge_modules'>edge_modules</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_compression'>https_edge_route_compression</span><span class='period'>.</span><span class='id identifier rubyid_replace!'>replace!</span><span class='lparen'>(</span>
109
- <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
110
- <span class='label'>id:</span> <span class='id identifier rubyid_route'>route</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
111
- <span class='label'>a_module:</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>false</span><span class='rbrace'>}</span><span class='rparen'>)</span>
84
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
85
+ <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
86
+
87
+ <span class='comment'># Get an instance of the api_keys client and list all API keys
88
+ </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
89
+ <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
90
+
91
+ <span class='comment'># Or set up an edge and backend with the ability to change your configuration later
92
+ </span><span class='id identifier rubyid_edge'>edge</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https'>https</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
93
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A Ruby Created Edge</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
94
+ <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{&quot;client&quot;: &quot;ruby&quot;}</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
95
+ <span class='label'>hostports:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>your-subdomain.ngrok.io:443</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
96
+ <span class='rparen'>)</span>
97
+
98
+ <span class='id identifier rubyid_backend'>backend</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_backends'>backends</span><span class='period'>.</span><span class='id identifier rubyid_tunnel_group'>tunnel_group</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
99
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A Ruby Created Backend</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
100
+ <span class='label'>labels:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>client_example</span><span class='label_end'>&quot;:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ruby</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span>
101
+ <span class='rparen'>)</span>
102
+
103
+ <span class='id identifier rubyid_route'>route</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https_routes'>https_routes</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
104
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
105
+ <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>path_prefix</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
106
+ <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
107
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Root</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
108
+ <span class='label'>backend:</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html" title="NgrokAPI::Models::EndpointBackendMutate (class)">EndpointBackendMutate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointBackendMutate#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>backend_id</span><span class='label_end'>&quot;:</span> <span class='id identifier rubyid_backend'>backend</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='comma'>,</span>
109
+ <span class='label'>compression:</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='rbrace'>}</span><span class='rparen'>)</span>
110
+ <span class='rparen'>)</span>
111
+
112
+ <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edge_modules'>edge_modules</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_compression'>https_edge_route_compression</span><span class='period'>.</span><span class='id identifier rubyid_replace!'>replace!</span><span class='lparen'>(</span>
113
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
114
+ <span class='label'>id:</span> <span class='id identifier rubyid_route'>route</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
115
+ <span class='label'>a_module:</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>false</span><span class='rbrace'>}</span><span class='rparen'>)</span>
112
116
  <span class='rparen'>)</span>
113
117
  </code></pre>
114
118
 
@@ -134,18 +138,18 @@
134
138
 
135
139
  <p>Rubocop can be run with the command:</p>
136
140
 
137
- <pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder
138
- </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib</span><span class='tstring_end'>&#39;</span></span>
139
-
140
- <span class='comment'># Run rubcop on all files
141
+ <pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder
142
+ </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib</span><span class='tstring_end'>&#39;</span></span>
143
+
144
+ <span class='comment'># Run rubcop on all files
141
145
  </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span>
142
146
  </code></pre>
143
147
  </div></div>
144
148
 
145
149
  <div id="footer">
146
- Generated on Mon Apr 11 19:32:55 2022 by
147
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
148
- 0.9.27 (ruby-2.7.5).
150
+ Generated on Thu Aug 24 20:57:26 2023 by
151
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
152
+ 0.9.34 (ruby-3.0.6).
149
153
  </div>
150
154
 
151
155
  </div>
data/doc/frames.html CHANGED
@@ -2,7 +2,7 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8">
5
- <title>Documentation by YARD 0.9.27</title>
5
+ <title>Documentation by YARD 0.9.34</title>
6
6
  </head>
7
7
  <script type="text/javascript">
8
8
  var match = unescape(window.location.hash).match(/^#!(.+)/);
data/doc/index.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  File: README
8
8
 
9
- &mdash; Documentation by YARD 0.9.27
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
@@ -57,7 +57,7 @@
57
57
  <div class="clear"></div>
58
58
  </div>
59
59
 
60
- <div id="content"><div id='filecontents'>
60
+ <div id="content"><div id='filecontents'><!-- Code generated for API Clients. DO NOT EDIT. -->
61
61
  <h1 id="label-ngrok+API+client+library+for+Ruby">ngrok API client library for Ruby</h1>
62
62
 
63
63
  <p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it easier to consume in Ruby.</p>
@@ -69,6 +69,10 @@
69
69
  <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ngrok'>ngrok</span><span class='op'>-</span><span class='id identifier rubyid_api'>api</span>
70
70
  </code></pre>
71
71
 
72
+ <h2 id="label-Support">Support</h2>
73
+
74
+ <p>The best place to get support using this library is through the <a href="https://ngrok.com/slack">ngrok Slack Community</a>. If you find any bugs, please contribute by opening a <a href="https://github.com/ngrok/ngrok-api-ruby/issues/new/choose">new GitHub issue</a>.</p>
75
+
72
76
  <h2 id="label-Documentation">Documentation</h2>
73
77
 
74
78
  <p>A quickstart guide and a full API reference are included in the <a href="https://ruby-api.docs.ngrok.com">ngrok Ruby API documentation</a></p>
@@ -77,38 +81,38 @@
77
81
 
78
82
  <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p>
79
83
 
80
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
81
- <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
82
-
83
- <span class='comment'># Get an instance of the api_keys client and list all API keys
84
- </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
85
- <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
86
-
87
- <span class='comment'># Or set up an edge and backend with the ability to change your configuration later
88
- </span><span class='id identifier rubyid_edge'>edge</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https'>https</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
89
- <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A Ruby Created Edge</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
90
- <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{&quot;client&quot;: &quot;ruby&quot;}</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
91
- <span class='label'>hostports:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>your-subdomain.ngrok.io:443</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
92
- <span class='rparen'>)</span>
93
-
94
- <span class='id identifier rubyid_backend'>backend</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_backends'>backends</span><span class='period'>.</span><span class='id identifier rubyid_tunnel_group'>tunnel_group</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
95
- <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A Ruby Created Backend</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
96
- <span class='label'>labels:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>client_example</span><span class='label_end'>&quot;:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ruby</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span>
97
- <span class='rparen'>)</span>
98
-
99
- <span class='id identifier rubyid_route'>route</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https_routes'>https_routes</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
100
- <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
101
- <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>path_prefix</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
102
- <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
103
- <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Root</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
104
- <span class='label'>backend:</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html" title="NgrokAPI::Models::EndpointBackendMutate (class)">EndpointBackendMutate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointBackendMutate#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>backend_id</span><span class='label_end'>&quot;:</span> <span class='id identifier rubyid_backend'>backend</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='comma'>,</span>
105
- <span class='label'>compression:</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='rbrace'>}</span><span class='rparen'>)</span>
106
- <span class='rparen'>)</span>
107
-
108
- <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edge_modules'>edge_modules</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_compression'>https_edge_route_compression</span><span class='period'>.</span><span class='id identifier rubyid_replace!'>replace!</span><span class='lparen'>(</span>
109
- <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
110
- <span class='label'>id:</span> <span class='id identifier rubyid_route'>route</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
111
- <span class='label'>a_module:</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>false</span><span class='rbrace'>}</span><span class='rparen'>)</span>
84
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
85
+ <span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
86
+
87
+ <span class='comment'># Get an instance of the api_keys client and list all API keys
88
+ </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
89
+ <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
90
+
91
+ <span class='comment'># Or set up an edge and backend with the ability to change your configuration later
92
+ </span><span class='id identifier rubyid_edge'>edge</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https'>https</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
93
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A Ruby Created Edge</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
94
+ <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{&quot;client&quot;: &quot;ruby&quot;}</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
95
+ <span class='label'>hostports:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>your-subdomain.ngrok.io:443</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
96
+ <span class='rparen'>)</span>
97
+
98
+ <span class='id identifier rubyid_backend'>backend</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_backends'>backends</span><span class='period'>.</span><span class='id identifier rubyid_tunnel_group'>tunnel_group</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
99
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>A Ruby Created Backend</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
100
+ <span class='label'>labels:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>client_example</span><span class='label_end'>&quot;:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ruby</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span>
101
+ <span class='rparen'>)</span>
102
+
103
+ <span class='id identifier rubyid_route'>route</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https_routes'>https_routes</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
104
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
105
+ <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>path_prefix</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
106
+ <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
107
+ <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Root</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
108
+ <span class='label'>backend:</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html" title="NgrokAPI::Models::EndpointBackendMutate (class)">EndpointBackendMutate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointBackendMutate#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>backend_id</span><span class='label_end'>&quot;:</span> <span class='id identifier rubyid_backend'>backend</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='comma'>,</span>
109
+ <span class='label'>compression:</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='rbrace'>}</span><span class='rparen'>)</span>
110
+ <span class='rparen'>)</span>
111
+
112
+ <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edge_modules'>edge_modules</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_compression'>https_edge_route_compression</span><span class='period'>.</span><span class='id identifier rubyid_replace!'>replace!</span><span class='lparen'>(</span>
113
+ <span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
114
+ <span class='label'>id:</span> <span class='id identifier rubyid_route'>route</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
115
+ <span class='label'>a_module:</span> <span class='const'><span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>enabled</span><span class='label_end'>&quot;:</span> <span class='kw'>false</span><span class='rbrace'>}</span><span class='rparen'>)</span>
112
116
  <span class='rparen'>)</span>
113
117
  </code></pre>
114
118
 
@@ -134,18 +138,18 @@
134
138
 
135
139
  <p>Rubocop can be run with the command:</p>
136
140
 
137
- <pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder
138
- </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib</span><span class='tstring_end'>&#39;</span></span>
139
-
140
- <span class='comment'># Run rubcop on all files
141
+ <pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder
142
+ </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib</span><span class='tstring_end'>&#39;</span></span>
143
+
144
+ <span class='comment'># Run rubcop on all files
141
145
  </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span>
142
146
  </code></pre>
143
147
  </div></div>
144
148
 
145
149
  <div id="footer">
146
- Generated on Mon Apr 11 19:32:55 2022 by
147
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
148
- 0.9.27 (ruby-2.7.5).
150
+ Generated on Thu Aug 24 20:57:26 2023 by
151
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
152
+ 0.9.34 (ruby-3.0.6).
149
153
  </div>
150
154
 
151
155
  </div>