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
@@ -0,0 +1,141 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
5
+ module NgrokAPI
6
+ module Services
7
+ ##
8
+ # https://ngrok.com/docs/api#api-application-users
9
+ class ApplicationUsersClient
10
+ # The API path for the requests
11
+ PATH = '/app/users/%{id}'
12
+ # The List Property from the resulting API for list calls
13
+ LIST_PROPERTY = 'application_users'
14
+
15
+ attr_reader :client
16
+
17
+ def initialize(client:)
18
+ @client = client
19
+ end
20
+
21
+ ##
22
+ # Get an application user by ID.
23
+ #
24
+ # @param [string] id a resource identifier
25
+ # @return [NgrokAPI::Models::ApplicationUser] result from the API request
26
+ #
27
+ # https://ngrok.com/docs/api#api-application-users-get
28
+ def get(id: "")
29
+ path = '/app/users/%{id}'
30
+ replacements = {
31
+ id: id,
32
+ }
33
+ data = {}
34
+ result = @client.get(path % replacements, data: data)
35
+ NgrokAPI::Models::ApplicationUser.new(client: self, attrs: result)
36
+ end
37
+
38
+ ##
39
+ # Get an application user by ID.
40
+ # Throws an exception if API error.
41
+ #
42
+ # @param [string] id a resource identifier
43
+ # @return [NgrokAPI::Models::ApplicationUser] result from the API request
44
+ #
45
+ # https://ngrok.com/docs/api#api-application-users-get
46
+ def get!(id: "")
47
+ path = '/app/users/%{id}'
48
+ replacements = {
49
+ id: id,
50
+ }
51
+ data = {}
52
+ result = @client.get(path % replacements, data: data, danger: true)
53
+ NgrokAPI::Models::ApplicationUser.new(client: self, attrs: result)
54
+ end
55
+
56
+ ##
57
+ # Delete an application user by ID.
58
+ #
59
+ # @param [string] id a resource identifier
60
+ # @return [NgrokAPI::Models::Empty] result from the API request
61
+ #
62
+ # https://ngrok.com/docs/api#api-application-users-delete
63
+ def delete(id: "")
64
+ path = '/app/users/%{id}'
65
+ replacements = {
66
+ id: id,
67
+ }
68
+ @client.delete(path % replacements)
69
+ end
70
+
71
+ ##
72
+ # Delete an application user by ID.
73
+ # Throws an exception if API error.
74
+ #
75
+ # @param [string] id a resource identifier
76
+ # @return [NgrokAPI::Models::Empty] result from the API request
77
+ #
78
+ # https://ngrok.com/docs/api#api-application-users-delete
79
+ def delete!(id: "")
80
+ path = '/app/users/%{id}'
81
+ replacements = {
82
+ id: id,
83
+ }
84
+ @client.delete(path % replacements, danger: true)
85
+ end
86
+
87
+ ##
88
+ # List all application users for this account.
89
+ #
90
+ # @param [string] before_id
91
+ # @param [string] limit
92
+ # @param [string] url optional and mutually exclusive from before_id and limit
93
+ # @return [NgrokAPI::Models::Listable] result from the API request
94
+ #
95
+ # https://ngrok.com/docs/api#api-application-users-list
96
+ def list(before_id: nil, limit: nil, url: nil)
97
+ result = @client.list(
98
+ before_id: before_id,
99
+ limit: limit,
100
+ url: url,
101
+ path: PATH
102
+ )
103
+
104
+ NgrokAPI::Models::Listable.new(
105
+ client: self,
106
+ attrs: result,
107
+ list_property: LIST_PROPERTY,
108
+ klass: NgrokAPI::Models::ApplicationUser
109
+ )
110
+ end
111
+
112
+ ##
113
+ # List all application users for this account.
114
+ # Throws an exception if API error.
115
+ #
116
+ # @param [string] before_id
117
+ # @param [string] limit
118
+ # @param [string] url optional and mutually exclusive from before_id and limit
119
+ # @return [NgrokAPI::Models::Listable] result from the API request
120
+ #
121
+ # https://ngrok.com/docs/api#api-application-users-list
122
+ def list!(before_id: nil, limit: nil, url: nil)
123
+ result = @client.list(
124
+ before_id: before_id,
125
+ limit: limit,
126
+ danger: true,
127
+ url: url,
128
+ path: PATH
129
+ )
130
+
131
+ NgrokAPI::Models::Listable.new(
132
+ client: self,
133
+ attrs: result,
134
+ list_property: LIST_PROPERTY,
135
+ klass: NgrokAPI::Models::ApplicationUser,
136
+ danger: true
137
+ )
138
+ end
139
+ end
140
+ end
141
+ end
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,11 +1,13 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
6
8
  # Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
7
9
  # agent to connect the ngrok service as your account. They are installed with
8
- # the `ngrok authtoken` command or by specifying it in the `ngrok.yml`
10
+ # the `ngrok config add-authtoken` command or by specifying it in the `ngrok.yml`
9
11
  # configuration file with the `authtoken` property.
10
12
  #
11
13
  # https://ngrok.com/docs/api#api-credentials
@@ -29,11 +31,12 @@ module NgrokAPI
29
31
  #
30
32
  # @param [string] description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
31
33
  # @param [string] metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
32
- # @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` 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 ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
34
+ # @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` 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 ``bind:example.ngrok.io``. 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 ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, 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 ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
35
+ # @param [string] owner_id 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.
33
36
  # @return [NgrokAPI::Models::Credential] result from the API request
34
37
  #
35
38
  # https://ngrok.com/docs/api#api-credentials-create
36
- def create(description: "", metadata: "", acl: [])
39
+ def create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "")
37
40
  path = '/credentials'
38
41
  replacements = {
39
42
  }
@@ -41,6 +44,7 @@ module NgrokAPI
41
44
  data[:description] = description if description
42
45
  data[:metadata] = metadata if metadata
43
46
  data[:acl] = acl if acl
47
+ data[:owner_id] = owner_id if owner_id
44
48
  result = @client.post(path % replacements, data: data)
45
49
  NgrokAPI::Models::Credential.new(client: self, attrs: result)
46
50
  end
@@ -54,11 +58,12 @@ module NgrokAPI
54
58
  #
55
59
  # @param [string] description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
56
60
  # @param [string] metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
57
- # @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` 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 ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
61
+ # @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` 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 ``bind:example.ngrok.io``. 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 ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, 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 ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
62
+ # @param [string] owner_id 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.
58
63
  # @return [NgrokAPI::Models::Credential] result from the API request
59
64
  #
60
65
  # https://ngrok.com/docs/api#api-credentials-create
61
- def create!(description: "", metadata: "", acl: [])
66
+ def create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "")
62
67
  path = '/credentials'
63
68
  replacements = {
64
69
  }
@@ -66,6 +71,7 @@ module NgrokAPI
66
71
  data[:description] = description if description
67
72
  data[:metadata] = metadata if metadata
68
73
  data[:acl] = acl if acl
74
+ data[:owner_id] = owner_id if owner_id
69
75
  result = @client.post(path % replacements, data: data, danger: true)
70
76
  NgrokAPI::Models::Credential.new(client: self, attrs: result)
71
77
  end
@@ -195,7 +201,7 @@ module NgrokAPI
195
201
  # @param [string] id
196
202
  # @param [string] description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
197
203
  # @param [string] metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
198
- # @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` 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 ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
204
+ # @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` 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 ``bind:example.ngrok.io``. 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 ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, 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 ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
199
205
  # @return [NgrokAPI::Models::Credential] result from the API request
200
206
  #
201
207
  # https://ngrok.com/docs/api#api-credentials-update
@@ -219,7 +225,7 @@ module NgrokAPI
219
225
  # @param [string] id
220
226
  # @param [string] description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
221
227
  # @param [string] metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
222
- # @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` 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 ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
228
+ # @param [List<string>] acl optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` 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 ``bind:example.ngrok.io``. 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 ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, 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 ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
223
229
  # @return [NgrokAPI::Models::Credential] result from the API request
224
230
  #
225
231
  # https://ngrok.com/docs/api#api-credentials-update
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -18,8 +20,7 @@ module NgrokAPI
18
20
 
19
21
  ##
20
22
  # Create a new Event Destination. It will not apply to anything until it is
21
- # associated with an Event Stream, and that Event Stream is associated with an
22
- # Endpoint Config.
23
+ # associated with an Event Subscription.
23
24
  #
24
25
  # @param [string] metadata Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
25
26
  # @param [string] description Human-readable description of the Event Destination. Optional, max 255 bytes.
@@ -43,8 +44,7 @@ module NgrokAPI
43
44
 
44
45
  ##
45
46
  # Create a new Event Destination. It will not apply to anything until it is
46
- # associated with an Event Stream, and that Event Stream is associated with an
47
- # Endpoint Config.
47
+ # associated with an Event Subscription.
48
48
  # Throws an exception if API error.
49
49
  #
50
50
  # @param [string] metadata Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -30,7 +32,7 @@ module NgrokAPI
30
32
  # @return [NgrokAPI::Models::IPPolicyRule] result from the API request
31
33
  #
32
34
  # https://ngrok.com/docs/api#api-ip-policy-rules-create
33
- def create(description: "", metadata: "", cidr:, ip_policy_id:, action: nil)
35
+ def create(description: "", metadata: "", cidr:, ip_policy_id:, action:)
34
36
  path = '/ip_policy_rules'
35
37
  replacements = {
36
38
  }
@@ -56,7 +58,7 @@ module NgrokAPI
56
58
  # @return [NgrokAPI::Models::IPPolicyRule] result from the API request
57
59
  #
58
60
  # https://ngrok.com/docs/api#api-ip-policy-rules-create
59
- def create!(description: "", metadata: "", cidr:, ip_policy_id:, action: nil)
61
+ def create!(description: "", metadata: "", cidr:, ip_policy_id:, action:)
60
62
  path = '/ip_policy_rules'
61
63
  replacements = {
62
64
  }
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##
@@ -24,7 +26,7 @@ module NgrokAPI
24
26
  ##
25
27
  # Create a new reserved domain.
26
28
  #
27
- # @param [string] name the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
29
+ # @param [string] domain hostname of the reserved domain
28
30
  # @param [string] region reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
29
31
  # @param [string] description human-readable description of what this reserved domain will be used for
30
32
  # @param [string] metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
@@ -33,12 +35,12 @@ module NgrokAPI
33
35
  # @return [NgrokAPI::Models::ReservedDomain] result from the API request
34
36
  #
35
37
  # https://ngrok.com/docs/api#api-reserved-domains-create
36
- def create(name:, region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil)
38
+ def create(name: "", domain: "", region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil)
37
39
  path = '/reserved_domains'
38
40
  replacements = {
39
41
  }
40
42
  data = {}
41
- data[:name] = name if name
43
+ data[:domain] = domain if domain
42
44
  data[:region] = region if region
43
45
  data[:description] = description if description
44
46
  data[:metadata] = metadata if metadata
@@ -52,7 +54,7 @@ module NgrokAPI
52
54
  # Create a new reserved domain.
53
55
  # Throws an exception if API error.
54
56
  #
55
- # @param [string] name the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
57
+ # @param [string] domain hostname of the reserved domain
56
58
  # @param [string] region reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
57
59
  # @param [string] description human-readable description of what this reserved domain will be used for
58
60
  # @param [string] metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
@@ -61,12 +63,12 @@ module NgrokAPI
61
63
  # @return [NgrokAPI::Models::ReservedDomain] result from the API request
62
64
  #
63
65
  # https://ngrok.com/docs/api#api-reserved-domains-create
64
- def create!(name:, region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil)
66
+ def create!(name: "", domain: "", region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil)
65
67
  path = '/reserved_domains'
66
68
  replacements = {
67
69
  }
68
70
  data = {}
69
- data[:name] = name if name
71
+ data[:domain] = domain if domain
70
72
  data[:region] = region if region
71
73
  data[:description] = description if description
72
74
  data[:metadata] = metadata if metadata
@@ -206,7 +208,7 @@ module NgrokAPI
206
208
  # @return [NgrokAPI::Models::ReservedDomain] result from the API request
207
209
  #
208
210
  # https://ngrok.com/docs/api#api-reserved-domains-update
209
- def update(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil)
211
+ def update(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil, region: nil)
210
212
  path = '/reserved_domains/%{id}'
211
213
  replacements = {
212
214
  id: id,
@@ -232,7 +234,7 @@ module NgrokAPI
232
234
  # @return [NgrokAPI::Models::ReservedDomain] result from the API request
233
235
  #
234
236
  # https://ngrok.com/docs/api#api-reserved-domains-update
235
- def update!(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil)
237
+ def update!(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil, region: nil)
236
238
  path = '/reserved_domains/%{id}'
237
239
  replacements = {
238
240
  id: id,
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
3
5
  module NgrokAPI
4
6
  module Services
5
7
  ##