ngrok-api 0.26.0 → 0.28.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 (373) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/Gemfile.lock +1 -11
  4. data/doc/NgrokAPI/Client.html +100 -48
  5. data/doc/NgrokAPI/Error.html +2 -2
  6. data/doc/NgrokAPI/Errors/NotFoundError.html +2 -2
  7. data/doc/NgrokAPI/Errors.html +2 -2
  8. data/doc/NgrokAPI/HttpClient.html +2 -2
  9. data/doc/NgrokAPI/Models/APIKey.html +2 -2
  10. data/doc/NgrokAPI/Models/AWSAuth.html +2 -2
  11. data/doc/NgrokAPI/Models/AWSCredentials.html +2 -2
  12. data/doc/NgrokAPI/Models/AWSRole.html +2 -2
  13. data/doc/NgrokAPI/Models/AbuseReport.html +2 -2
  14. data/doc/NgrokAPI/Models/AbuseReportHostname.html +2 -2
  15. data/doc/NgrokAPI/Models/AgentIngress.html +2 -2
  16. data/doc/NgrokAPI/Models/AgentIngressCertJob.html +2 -2
  17. data/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +2 -2
  18. data/doc/NgrokAPI/Models/AgentIngressCertStatus.html +2 -2
  19. data/doc/NgrokAPI/Models/ApplicationSession.html +2 -2
  20. data/doc/NgrokAPI/Models/ApplicationUser.html +2 -2
  21. data/doc/NgrokAPI/Models/BotUser.html +2 -2
  22. data/doc/NgrokAPI/Models/BrowserSession.html +2 -2
  23. data/doc/NgrokAPI/Models/CertificateAuthority.html +2 -2
  24. data/doc/NgrokAPI/Models/Credential.html +2 -2
  25. data/doc/NgrokAPI/Models/Endpoint.html +5 -5
  26. data/doc/NgrokAPI/Models/EndpointBackend.html +2 -2
  27. data/doc/NgrokAPI/Models/EndpointBackendMutate.html +2 -2
  28. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
  29. data/doc/NgrokAPI/Models/EndpointCompression.html +2 -2
  30. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
  31. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
  32. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
  33. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
  34. data/doc/NgrokAPI/Models/EndpointOAuth.html +2 -2
  35. data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +2 -2
  36. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
  37. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
  38. data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +2 -2
  39. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
  40. data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +2 -2
  41. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
  42. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
  43. data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +2 -2
  44. data/doc/NgrokAPI/Models/EndpointOIDC.html +2 -2
  45. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
  46. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
  47. data/doc/NgrokAPI/Models/EndpointSAML.html +2 -2
  48. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
  49. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
  50. data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +2 -2
  51. data/doc/NgrokAPI/Models/EndpointTrafficPolicy.html +2 -2
  52. data/doc/NgrokAPI/Models/EndpointUserAgentFilter.html +2 -2
  53. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
  54. data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +2 -2
  55. data/doc/NgrokAPI/Models/EventDestination.html +2 -2
  56. data/doc/NgrokAPI/Models/EventSource.html +2 -2
  57. data/doc/NgrokAPI/Models/EventSourceList.html +2 -2
  58. data/doc/NgrokAPI/Models/EventSourceReplace.html +2 -2
  59. data/doc/NgrokAPI/Models/EventSubscription.html +2 -2
  60. data/doc/NgrokAPI/Models/EventTarget.html +2 -2
  61. data/doc/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +2 -2
  62. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
  63. data/doc/NgrokAPI/Models/EventTargetDatadog.html +2 -2
  64. data/doc/NgrokAPI/Models/EventTargetFirehose.html +2 -2
  65. data/doc/NgrokAPI/Models/EventTargetKinesis.html +2 -2
  66. data/doc/NgrokAPI/Models/FailoverBackend.html +2 -2
  67. data/doc/NgrokAPI/Models/HTTPResponseBackend.html +2 -2
  68. data/doc/NgrokAPI/Models/HTTPSEdge.html +2 -2
  69. data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +2 -2
  70. data/doc/NgrokAPI/Models/IPPolicy.html +2 -2
  71. data/doc/NgrokAPI/Models/IPPolicyRule.html +2 -2
  72. data/doc/NgrokAPI/Models/IPRestriction.html +2 -2
  73. data/doc/NgrokAPI/Models/IdentityProvider.html +2 -2
  74. data/doc/NgrokAPI/Models/Listable.html +2 -2
  75. data/doc/NgrokAPI/Models/Location.html +2 -2
  76. data/doc/NgrokAPI/Models/Ref.html +2 -2
  77. data/doc/NgrokAPI/Models/ReservedAddr.html +2 -2
  78. data/doc/NgrokAPI/Models/ReservedDomain.html +95 -21
  79. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
  80. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
  81. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
  82. data/doc/NgrokAPI/Models/ReservedDomainResolvesToEntry.html +595 -0
  83. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
  84. data/doc/NgrokAPI/Models/SSHCredential.html +2 -2
  85. data/doc/NgrokAPI/Models/SSHHostCertificate.html +2 -2
  86. data/doc/NgrokAPI/Models/SSHUserCertificate.html +2 -2
  87. data/doc/NgrokAPI/Models/Secret.html +95 -21
  88. data/doc/NgrokAPI/Models/ServiceUser.html +1051 -0
  89. data/doc/NgrokAPI/Models/StaticBackend.html +2 -2
  90. data/doc/NgrokAPI/Models/StaticBackendTLS.html +2 -2
  91. data/doc/NgrokAPI/Models/TCPEdge.html +2 -2
  92. data/doc/NgrokAPI/Models/TLSCertificate.html +2 -2
  93. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
  94. data/doc/NgrokAPI/Models/TLSEdge.html +2 -2
  95. data/doc/NgrokAPI/Models/Tunnel.html +2 -2
  96. data/doc/NgrokAPI/Models/TunnelGroupBackend.html +2 -2
  97. data/doc/NgrokAPI/Models/TunnelSession.html +2 -2
  98. data/doc/NgrokAPI/Models/UserAgent.html +2 -2
  99. data/doc/NgrokAPI/Models/Vault.html +2 -2
  100. data/doc/NgrokAPI/Models/WeightedBackend.html +2 -2
  101. data/doc/NgrokAPI/Models.html +4 -4
  102. data/doc/NgrokAPI/PagedIterator.html +2 -2
  103. data/doc/NgrokAPI/Services/APIKeysClient.html +95 -31
  104. data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -2
  105. data/doc/NgrokAPI/Services/AgentIngressesClient.html +95 -31
  106. data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +2 -2
  107. data/doc/NgrokAPI/Services/ApplicationUsersClient.html +2 -2
  108. data/doc/NgrokAPI/Services/BotUsersClient.html +2 -2
  109. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +99 -35
  110. data/doc/NgrokAPI/Services/CredentialsClient.html +103 -39
  111. data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +2 -2
  112. data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +2 -2
  113. data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +2 -2
  114. data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +2 -2
  115. data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +2 -2
  116. data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +2 -2
  117. data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +2 -2
  118. data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +2 -2
  119. data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +2 -2
  120. data/doc/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +2 -2
  121. data/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +2 -2
  122. data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +2 -2
  123. data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +2 -2
  124. data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +2 -2
  125. data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2 -2
  126. data/doc/NgrokAPI/Services/EdgesTCPClient.html +2 -2
  127. data/doc/NgrokAPI/Services/EdgesTLSClient.html +2 -2
  128. data/doc/NgrokAPI/Services/EndpointsClient.html +163 -79
  129. data/doc/NgrokAPI/Services/EventDestinationsClient.html +95 -31
  130. data/doc/NgrokAPI/Services/EventSourcesClient.html +2 -2
  131. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +95 -31
  132. data/doc/NgrokAPI/Services/FailoverBackendsClient.html +2 -2
  133. data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +2 -2
  134. data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +2 -2
  135. data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +2 -2
  136. data/doc/NgrokAPI/Services/IPPoliciesClient.html +95 -31
  137. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +95 -31
  138. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +95 -31
  139. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +95 -31
  140. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +270 -126
  141. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +99 -35
  142. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +101 -37
  143. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +6 -6
  144. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +6 -6
  145. data/doc/NgrokAPI/Services/SecretsClient.html +181 -73
  146. data/doc/NgrokAPI/Services/ServiceUsersClient.html +1797 -0
  147. data/doc/NgrokAPI/Services/StaticBackendsClient.html +2 -2
  148. data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +2 -2
  149. data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +2 -2
  150. data/doc/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +2 -2
  151. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +95 -31
  152. data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +2 -2
  153. data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +2 -2
  154. data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +2 -2
  155. data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +2 -2
  156. data/doc/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +2 -2
  157. data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +2 -2
  158. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +143 -79
  159. data/doc/NgrokAPI/Services/TunnelsClient.html +2 -2
  160. data/doc/NgrokAPI/Services/VaultsClient.html +79 -15
  161. data/doc/NgrokAPI/Services/WeightedBackendsClient.html +2 -2
  162. data/doc/NgrokAPI/Services.html +4 -4
  163. data/doc/NgrokAPI.html +3 -3
  164. data/doc/_index.html +23 -2
  165. data/doc/class_list.html +1 -1
  166. data/doc/file.README.html +2 -2
  167. data/doc/index.html +2 -2
  168. data/doc/method_list.html +1092 -812
  169. data/doc/top-level-namespace.html +2 -2
  170. data/docs/NgrokAPI/Client.html +100 -48
  171. data/docs/NgrokAPI/Error.html +2 -2
  172. data/docs/NgrokAPI/Errors/NotFoundError.html +2 -2
  173. data/docs/NgrokAPI/Errors.html +2 -2
  174. data/docs/NgrokAPI/HttpClient.html +2 -2
  175. data/docs/NgrokAPI/Models/APIKey.html +2 -2
  176. data/docs/NgrokAPI/Models/AWSAuth.html +2 -2
  177. data/docs/NgrokAPI/Models/AWSCredentials.html +2 -2
  178. data/docs/NgrokAPI/Models/AWSRole.html +2 -2
  179. data/docs/NgrokAPI/Models/AbuseReport.html +2 -2
  180. data/docs/NgrokAPI/Models/AbuseReportHostname.html +2 -2
  181. data/docs/NgrokAPI/Models/AgentIngress.html +2 -2
  182. data/docs/NgrokAPI/Models/AgentIngressCertJob.html +2 -2
  183. data/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +2 -2
  184. data/docs/NgrokAPI/Models/AgentIngressCertStatus.html +2 -2
  185. data/docs/NgrokAPI/Models/ApplicationSession.html +2 -2
  186. data/docs/NgrokAPI/Models/ApplicationUser.html +2 -2
  187. data/docs/NgrokAPI/Models/BotUser.html +2 -2
  188. data/docs/NgrokAPI/Models/BrowserSession.html +2 -2
  189. data/docs/NgrokAPI/Models/CertificateAuthority.html +2 -2
  190. data/docs/NgrokAPI/Models/Credential.html +2 -2
  191. data/docs/NgrokAPI/Models/Endpoint.html +5 -5
  192. data/docs/NgrokAPI/Models/EndpointBackend.html +2 -2
  193. data/docs/NgrokAPI/Models/EndpointBackendMutate.html +2 -2
  194. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
  195. data/docs/NgrokAPI/Models/EndpointCompression.html +2 -2
  196. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
  197. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
  198. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
  199. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
  200. data/docs/NgrokAPI/Models/EndpointOAuth.html +2 -2
  201. data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +2 -2
  202. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
  203. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
  204. data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +2 -2
  205. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
  206. data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +2 -2
  207. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
  208. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
  209. data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +2 -2
  210. data/docs/NgrokAPI/Models/EndpointOIDC.html +2 -2
  211. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
  212. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
  213. data/docs/NgrokAPI/Models/EndpointSAML.html +2 -2
  214. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
  215. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
  216. data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +2 -2
  217. data/docs/NgrokAPI/Models/EndpointTrafficPolicy.html +2 -2
  218. data/docs/NgrokAPI/Models/EndpointUserAgentFilter.html +2 -2
  219. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
  220. data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +2 -2
  221. data/docs/NgrokAPI/Models/EventDestination.html +2 -2
  222. data/docs/NgrokAPI/Models/EventSource.html +2 -2
  223. data/docs/NgrokAPI/Models/EventSourceList.html +2 -2
  224. data/docs/NgrokAPI/Models/EventSourceReplace.html +2 -2
  225. data/docs/NgrokAPI/Models/EventSubscription.html +2 -2
  226. data/docs/NgrokAPI/Models/EventTarget.html +2 -2
  227. data/docs/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +2 -2
  228. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
  229. data/docs/NgrokAPI/Models/EventTargetDatadog.html +2 -2
  230. data/docs/NgrokAPI/Models/EventTargetFirehose.html +2 -2
  231. data/docs/NgrokAPI/Models/EventTargetKinesis.html +2 -2
  232. data/docs/NgrokAPI/Models/FailoverBackend.html +2 -2
  233. data/docs/NgrokAPI/Models/HTTPResponseBackend.html +2 -2
  234. data/docs/NgrokAPI/Models/HTTPSEdge.html +2 -2
  235. data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +2 -2
  236. data/docs/NgrokAPI/Models/IPPolicy.html +2 -2
  237. data/docs/NgrokAPI/Models/IPPolicyRule.html +2 -2
  238. data/docs/NgrokAPI/Models/IPRestriction.html +2 -2
  239. data/docs/NgrokAPI/Models/IdentityProvider.html +2 -2
  240. data/docs/NgrokAPI/Models/Listable.html +2 -2
  241. data/docs/NgrokAPI/Models/Location.html +2 -2
  242. data/docs/NgrokAPI/Models/Ref.html +2 -2
  243. data/docs/NgrokAPI/Models/ReservedAddr.html +2 -2
  244. data/docs/NgrokAPI/Models/ReservedDomain.html +95 -21
  245. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
  246. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
  247. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
  248. data/docs/NgrokAPI/Models/ReservedDomainResolvesToEntry.html +595 -0
  249. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
  250. data/docs/NgrokAPI/Models/SSHCredential.html +2 -2
  251. data/docs/NgrokAPI/Models/SSHHostCertificate.html +2 -2
  252. data/docs/NgrokAPI/Models/SSHUserCertificate.html +2 -2
  253. data/docs/NgrokAPI/Models/Secret.html +95 -21
  254. data/docs/NgrokAPI/Models/ServiceUser.html +1051 -0
  255. data/docs/NgrokAPI/Models/StaticBackend.html +2 -2
  256. data/docs/NgrokAPI/Models/StaticBackendTLS.html +2 -2
  257. data/docs/NgrokAPI/Models/TCPEdge.html +2 -2
  258. data/docs/NgrokAPI/Models/TLSCertificate.html +2 -2
  259. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
  260. data/docs/NgrokAPI/Models/TLSEdge.html +2 -2
  261. data/docs/NgrokAPI/Models/Tunnel.html +2 -2
  262. data/docs/NgrokAPI/Models/TunnelGroupBackend.html +2 -2
  263. data/docs/NgrokAPI/Models/TunnelSession.html +2 -2
  264. data/docs/NgrokAPI/Models/UserAgent.html +2 -2
  265. data/docs/NgrokAPI/Models/Vault.html +2 -2
  266. data/docs/NgrokAPI/Models/WeightedBackend.html +2 -2
  267. data/docs/NgrokAPI/Models.html +4 -4
  268. data/docs/NgrokAPI/PagedIterator.html +2 -2
  269. data/docs/NgrokAPI/Services/APIKeysClient.html +95 -31
  270. data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -2
  271. data/docs/NgrokAPI/Services/AgentIngressesClient.html +95 -31
  272. data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +2 -2
  273. data/docs/NgrokAPI/Services/ApplicationUsersClient.html +2 -2
  274. data/docs/NgrokAPI/Services/BotUsersClient.html +2 -2
  275. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +99 -35
  276. data/docs/NgrokAPI/Services/CredentialsClient.html +103 -39
  277. data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +2 -2
  278. data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +2 -2
  279. data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +2 -2
  280. data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +2 -2
  281. data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +2 -2
  282. data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +2 -2
  283. data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +2 -2
  284. data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +2 -2
  285. data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +2 -2
  286. data/docs/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +2 -2
  287. data/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +2 -2
  288. data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +2 -2
  289. data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +2 -2
  290. data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +2 -2
  291. data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2 -2
  292. data/docs/NgrokAPI/Services/EdgesTCPClient.html +2 -2
  293. data/docs/NgrokAPI/Services/EdgesTLSClient.html +2 -2
  294. data/docs/NgrokAPI/Services/EndpointsClient.html +163 -79
  295. data/docs/NgrokAPI/Services/EventDestinationsClient.html +95 -31
  296. data/docs/NgrokAPI/Services/EventSourcesClient.html +2 -2
  297. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +95 -31
  298. data/docs/NgrokAPI/Services/FailoverBackendsClient.html +2 -2
  299. data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +2 -2
  300. data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +2 -2
  301. data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +2 -2
  302. data/docs/NgrokAPI/Services/IPPoliciesClient.html +95 -31
  303. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +95 -31
  304. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +95 -31
  305. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +95 -31
  306. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +270 -126
  307. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +99 -35
  308. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +101 -37
  309. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +6 -6
  310. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +6 -6
  311. data/docs/NgrokAPI/Services/SecretsClient.html +181 -73
  312. data/docs/NgrokAPI/Services/ServiceUsersClient.html +1797 -0
  313. data/docs/NgrokAPI/Services/StaticBackendsClient.html +2 -2
  314. data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +2 -2
  315. data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +2 -2
  316. data/docs/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +2 -2
  317. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +95 -31
  318. data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +2 -2
  319. data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +2 -2
  320. data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +2 -2
  321. data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +2 -2
  322. data/docs/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +2 -2
  323. data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +2 -2
  324. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +143 -79
  325. data/docs/NgrokAPI/Services/TunnelsClient.html +2 -2
  326. data/docs/NgrokAPI/Services/VaultsClient.html +79 -15
  327. data/docs/NgrokAPI/Services/WeightedBackendsClient.html +2 -2
  328. data/docs/NgrokAPI/Services.html +4 -4
  329. data/docs/NgrokAPI.html +3 -3
  330. data/docs/_index.html +23 -2
  331. data/docs/class_list.html +1 -1
  332. data/docs/file.README.html +2 -2
  333. data/docs/index.html +2 -2
  334. data/docs/method_list.html +1092 -812
  335. data/docs/top-level-namespace.html +2 -2
  336. data/lib/ngrokapi/client.rb +4 -0
  337. data/lib/ngrokapi/models/endpoint.rb +1 -1
  338. data/lib/ngrokapi/models/reserved_domain.rb +3 -1
  339. data/lib/ngrokapi/models/reserved_domain_resolves_to_entry.rb +31 -0
  340. data/lib/ngrokapi/models/secret.rb +3 -1
  341. data/lib/ngrokapi/models/service_user.rb +70 -0
  342. data/lib/ngrokapi/services/agent_ingresses_client.rb +10 -4
  343. data/lib/ngrokapi/services/api_keys_client.rb +10 -4
  344. data/lib/ngrokapi/services/certificate_authorities_client.rb +12 -6
  345. data/lib/ngrokapi/services/credentials_client.rb +14 -8
  346. data/lib/ngrokapi/services/endpoints_client.rb +18 -12
  347. data/lib/ngrokapi/services/event_destinations_client.rb +10 -4
  348. data/lib/ngrokapi/services/event_subscriptions_client.rb +10 -4
  349. data/lib/ngrokapi/services/ip_policies_client.rb +10 -4
  350. data/lib/ngrokapi/services/ip_policy_rules_client.rb +10 -4
  351. data/lib/ngrokapi/services/ip_restrictions_client.rb +10 -4
  352. data/lib/ngrokapi/services/reserved_addrs_client.rb +10 -4
  353. data/lib/ngrokapi/services/reserved_domains_client.rb +22 -8
  354. data/lib/ngrokapi/services/secrets_client.rb +16 -6
  355. data/lib/ngrokapi/services/service_users_client.rb +237 -0
  356. data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +12 -6
  357. data/lib/ngrokapi/services/ssh_credentials_client.rb +12 -6
  358. data/lib/ngrokapi/services/ssh_host_certificates_client.rb +2 -2
  359. data/lib/ngrokapi/services/ssh_user_certificates_client.rb +2 -2
  360. data/lib/ngrokapi/services/tls_certificates_client.rb +10 -4
  361. data/lib/ngrokapi/services/tunnel_sessions_client.rb +10 -4
  362. data/lib/ngrokapi/services/vaults_client.rb +10 -4
  363. data/lib/ngrokapi/version.rb +1 -1
  364. data/spec/ngrokapi/client_spec.rb +6 -0
  365. data/spec/ngrokapi/models/reserved_domain_resolves_to_entry_spec.rb +23 -0
  366. data/spec/ngrokapi/models/service_user_spec.rb +44 -0
  367. data/spec/ngrokapi/services/credentials_client_spec.rb +4 -2
  368. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +12 -4
  369. data/spec/ngrokapi/services/secrets_client_spec.rb +6 -2
  370. data/spec/ngrokapi/services/service_users_client_spec.rb +178 -0
  371. data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +4 -2
  372. data/spec/spec_helper.rb +26 -0
  373. metadata +14 -2
@@ -0,0 +1,1797 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: NgrokAPI::Services::ServiceUsersClient
8
+
9
+ &mdash; Documentation by YARD 0.9.36
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "NgrokAPI::Services::ServiceUsersClient";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (S)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
41
+ &raquo;
42
+ <span class="title">ServiceUsersClient</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: NgrokAPI::Services::ServiceUsersClient
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">NgrokAPI::Services::ServiceUsersClient</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/ngrokapi/services/service_users_client.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p><a href="https://ngrok.com/docs/api#api-service-users">ngrok.com/docs/api#api-service-users</a></p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+ <h2>
116
+ Constant Summary
117
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
118
+ </h2>
119
+
120
+ <dl class="constants">
121
+
122
+ <dt id="PATH-constant" class="">PATH =
123
+ <div class="docstring">
124
+ <div class="discussion">
125
+
126
+ <p>The API path for the requests</p>
127
+
128
+
129
+ </div>
130
+ </div>
131
+ <div class="tags">
132
+
133
+
134
+ </div>
135
+ </dt>
136
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/service_users</span><span class='tstring_end'>&#39;</span></span></pre></dd>
137
+
138
+ <dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
139
+ <div class="docstring">
140
+ <div class="discussion">
141
+
142
+ <p>The List Property from the resulting API for list calls</p>
143
+
144
+
145
+ </div>
146
+ </div>
147
+ <div class="tags">
148
+
149
+
150
+ </div>
151
+ </dt>
152
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>service_users</span><span class='tstring_end'>&#39;</span></span></pre></dd>
153
+
154
+ </dl>
155
+
156
+
157
+
158
+
159
+
160
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
161
+ <ul class="summary">
162
+
163
+ <li class="public ">
164
+ <span class="summary_signature">
165
+
166
+ <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; Object </a>
167
+
168
+
169
+
170
+ </span>
171
+
172
+
173
+
174
+
175
+ <span class="note title readonly">readonly</span>
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+ <span class="summary_desc"><div class='inline'>
186
+ <p>Returns the value of attribute client.</p>
187
+ </div></span>
188
+
189
+ </li>
190
+
191
+
192
+ </ul>
193
+
194
+
195
+
196
+
197
+
198
+ <h2>
199
+ Instance Method Summary
200
+ <small><a href="#" class="summary_toggle">collapse</a></small>
201
+ </h2>
202
+
203
+ <ul class="summary">
204
+
205
+ <li class="public ">
206
+ <span class="summary_signature">
207
+
208
+ <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(name: &quot;&quot;, active: nil) &#x21d2; NgrokAPI::Models::ServiceUser </a>
209
+
210
+
211
+
212
+ </span>
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+ <span class="summary_desc"><div class='inline'>
223
+ <p>Create a new service user.</p>
224
+ </div></span>
225
+
226
+ </li>
227
+
228
+
229
+ <li class="public ">
230
+ <span class="summary_signature">
231
+
232
+ <a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(name: &quot;&quot;, active: nil) &#x21d2; NgrokAPI::Models::ServiceUser </a>
233
+
234
+
235
+
236
+ </span>
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+ <span class="summary_desc"><div class='inline'>
247
+ <p>Create a new service user Throws an exception if API error.</p>
248
+ </div></span>
249
+
250
+ </li>
251
+
252
+
253
+ <li class="public ">
254
+ <span class="summary_signature">
255
+
256
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
257
+
258
+
259
+
260
+ </span>
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+ <span class="summary_desc"><div class='inline'>
271
+ <p>Delete a service user by ID.</p>
272
+ </div></span>
273
+
274
+ </li>
275
+
276
+
277
+ <li class="public ">
278
+ <span class="summary_signature">
279
+
280
+ <a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
281
+
282
+
283
+
284
+ </span>
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+ <span class="summary_desc"><div class='inline'>
295
+ <p>Delete a service user by ID Throws an exception if API error.</p>
296
+ </div></span>
297
+
298
+ </li>
299
+
300
+
301
+ <li class="public ">
302
+ <span class="summary_signature">
303
+
304
+ <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::ServiceUser </a>
305
+
306
+
307
+
308
+ </span>
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+ <span class="summary_desc"><div class='inline'>
319
+ <p>Get the details of a Bot User by ID.</p>
320
+ </div></span>
321
+
322
+ </li>
323
+
324
+
325
+ <li class="public ">
326
+ <span class="summary_signature">
327
+
328
+ <a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::ServiceUser </a>
329
+
330
+
331
+
332
+ </span>
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+ <span class="summary_desc"><div class='inline'>
343
+ <p>Get the details of a Bot User by ID.</p>
344
+ </div></span>
345
+
346
+ </li>
347
+
348
+
349
+ <li class="public ">
350
+ <span class="summary_signature">
351
+
352
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) &#x21d2; ServiceUsersClient </a>
353
+
354
+
355
+
356
+ </span>
357
+
358
+
359
+ <span class="note title constructor">constructor</span>
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+ <span class="summary_desc"><div class='inline'>
369
+ <p>A new instance of ServiceUsersClient.</p>
370
+ </div></span>
371
+
372
+ </li>
373
+
374
+
375
+ <li class="public ">
376
+ <span class="summary_signature">
377
+
378
+ <a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, filter: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
379
+
380
+
381
+
382
+ </span>
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+ <span class="summary_desc"><div class='inline'>
393
+ <p>List all service users in this account.</p>
394
+ </div></span>
395
+
396
+ </li>
397
+
398
+
399
+ <li class="public ">
400
+ <span class="summary_signature">
401
+
402
+ <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, filter: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
403
+
404
+
405
+
406
+ </span>
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+ <span class="summary_desc"><div class='inline'>
417
+ <p>List all service users in this account.</p>
418
+ </div></span>
419
+
420
+ </li>
421
+
422
+
423
+ <li class="public ">
424
+ <span class="summary_signature">
425
+
426
+ <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: &quot;&quot;, name: nil, active: nil) &#x21d2; NgrokAPI::Models::ServiceUser </a>
427
+
428
+
429
+
430
+ </span>
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+ <span class="summary_desc"><div class='inline'>
441
+ <p>Update attributes of a service user by ID.</p>
442
+ </div></span>
443
+
444
+ </li>
445
+
446
+
447
+ <li class="public ">
448
+ <span class="summary_signature">
449
+
450
+ <a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: &quot;&quot;, name: nil, active: nil) &#x21d2; NgrokAPI::Models::ServiceUser </a>
451
+
452
+
453
+
454
+ </span>
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+ <span class="summary_desc"><div class='inline'>
465
+ <p>Update attributes of a service user by ID.</p>
466
+ </div></span>
467
+
468
+ </li>
469
+
470
+
471
+ </ul>
472
+
473
+
474
+ <div id="constructor_details" class="method_details_list">
475
+ <h2>Constructor Details</h2>
476
+
477
+ <div class="method_details first">
478
+ <h3 class="signature first" id="initialize-instance_method">
479
+
480
+ #<strong>initialize</strong>(client:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Services::ServiceUsersClient (class)">ServiceUsersClient</a></span></tt>
481
+
482
+
483
+
484
+
485
+
486
+ </h3><div class="docstring">
487
+ <div class="discussion">
488
+
489
+ <p>Returns a new instance of ServiceUsersClient.</p>
490
+
491
+
492
+ </div>
493
+ </div>
494
+ <div class="tags">
495
+
496
+
497
+ </div><table class="source_code">
498
+ <tr>
499
+ <td>
500
+ <pre class="lines">
501
+
502
+
503
+ 17
504
+ 18
505
+ 19</pre>
506
+ </td>
507
+ <td>
508
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 17</span>
509
+
510
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
511
+ <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
512
+ <span class='kw'>end</span></pre>
513
+ </td>
514
+ </tr>
515
+ </table>
516
+ </div>
517
+
518
+ </div>
519
+
520
+ <div id="instance_attr_details" class="attr_details">
521
+ <h2>Instance Attribute Details</h2>
522
+
523
+
524
+ <span id=""></span>
525
+ <div class="method_details first">
526
+ <h3 class="signature first" id="client-instance_method">
527
+
528
+ #<strong>client</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
529
+
530
+
531
+
532
+
533
+
534
+ </h3><div class="docstring">
535
+ <div class="discussion">
536
+
537
+ <p>Returns the value of attribute client.</p>
538
+
539
+
540
+ </div>
541
+ </div>
542
+ <div class="tags">
543
+
544
+
545
+ </div><table class="source_code">
546
+ <tr>
547
+ <td>
548
+ <pre class="lines">
549
+
550
+
551
+ 15
552
+ 16
553
+ 17</pre>
554
+ </td>
555
+ <td>
556
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 15</span>
557
+
558
+ <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
559
+ <span class='ivar'>@client</span>
560
+ <span class='kw'>end</span></pre>
561
+ </td>
562
+ </tr>
563
+ </table>
564
+ </div>
565
+
566
+ </div>
567
+
568
+
569
+ <div id="instance_method_details" class="method_details_list">
570
+ <h2>Instance Method Details</h2>
571
+
572
+
573
+ <div class="method_details first">
574
+ <h3 class="signature first" id="create-instance_method">
575
+
576
+ #<strong>create</strong>(name: &quot;&quot;, active: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>
577
+
578
+
579
+
580
+
581
+
582
+ </h3><div class="docstring">
583
+ <div class="discussion">
584
+
585
+ <p>Create a new service user</p>
586
+
587
+ <p><a href="https://ngrok.com/docs/api#api-service-users-create">ngrok.com/docs/api#api-service-users-create</a></p>
588
+
589
+
590
+ </div>
591
+ </div>
592
+ <div class="tags">
593
+ <p class="tag_title">Parameters:</p>
594
+ <ul class="param">
595
+
596
+ <li>
597
+
598
+ <span class='name'>name</span>
599
+
600
+
601
+ <span class='type'>(<tt>string</tt>)</span>
602
+
603
+
604
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
605
+
606
+
607
+ &mdash;
608
+ <div class='inline'>
609
+ <p>human-readable name used to identify the service</p>
610
+ </div>
611
+
612
+ </li>
613
+
614
+ <li>
615
+
616
+ <span class='name'>active</span>
617
+
618
+
619
+ <span class='type'>(<tt>boolean</tt>)</span>
620
+
621
+
622
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
623
+
624
+
625
+ &mdash;
626
+ <div class='inline'>
627
+ <p>whether or not the service is active</p>
628
+ </div>
629
+
630
+ </li>
631
+
632
+ </ul>
633
+
634
+ <p class="tag_title">Returns:</p>
635
+ <ul class="return">
636
+
637
+ <li>
638
+
639
+
640
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>)</span>
641
+
642
+
643
+
644
+ &mdash;
645
+ <div class='inline'>
646
+ <p>result from the API request</p>
647
+ </div>
648
+
649
+ </li>
650
+
651
+ </ul>
652
+
653
+ </div><table class="source_code">
654
+ <tr>
655
+ <td>
656
+ <pre class="lines">
657
+
658
+
659
+ 29
660
+ 30
661
+ 31
662
+ 32
663
+ 33
664
+ 34
665
+ 35
666
+ 36
667
+ 37
668
+ 38</pre>
669
+ </td>
670
+ <td>
671
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 29</span>
672
+
673
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>active:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
674
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/service_users</span><span class='tstring_end'>&#39;</span></span>
675
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
676
+ <span class='rbrace'>}</span>
677
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
678
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
679
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:active</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_active'>active</span> <span class='kw'>if</span> <span class='id identifier rubyid_active'>active</span>
680
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
681
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ServiceUser.html#initialize-instance_method" title="NgrokAPI::Models::ServiceUser#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
682
+ <span class='kw'>end</span></pre>
683
+ </td>
684
+ </tr>
685
+ </table>
686
+ </div>
687
+
688
+ <div class="method_details ">
689
+ <h3 class="signature " id="create!-instance_method">
690
+
691
+ #<strong>create!</strong>(name: &quot;&quot;, active: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>
692
+
693
+
694
+
695
+
696
+
697
+ </h3><div class="docstring">
698
+ <div class="discussion">
699
+
700
+ <p>Create a new service user Throws an exception if API error.</p>
701
+
702
+ <p><a href="https://ngrok.com/docs/api#api-service-users-create">ngrok.com/docs/api#api-service-users-create</a></p>
703
+
704
+
705
+ </div>
706
+ </div>
707
+ <div class="tags">
708
+ <p class="tag_title">Parameters:</p>
709
+ <ul class="param">
710
+
711
+ <li>
712
+
713
+ <span class='name'>name</span>
714
+
715
+
716
+ <span class='type'>(<tt>string</tt>)</span>
717
+
718
+
719
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
720
+
721
+
722
+ &mdash;
723
+ <div class='inline'>
724
+ <p>human-readable name used to identify the service</p>
725
+ </div>
726
+
727
+ </li>
728
+
729
+ <li>
730
+
731
+ <span class='name'>active</span>
732
+
733
+
734
+ <span class='type'>(<tt>boolean</tt>)</span>
735
+
736
+
737
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
738
+
739
+
740
+ &mdash;
741
+ <div class='inline'>
742
+ <p>whether or not the service is active</p>
743
+ </div>
744
+
745
+ </li>
746
+
747
+ </ul>
748
+
749
+ <p class="tag_title">Returns:</p>
750
+ <ul class="return">
751
+
752
+ <li>
753
+
754
+
755
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>)</span>
756
+
757
+
758
+
759
+ &mdash;
760
+ <div class='inline'>
761
+ <p>result from the API request</p>
762
+ </div>
763
+
764
+ </li>
765
+
766
+ </ul>
767
+
768
+ </div><table class="source_code">
769
+ <tr>
770
+ <td>
771
+ <pre class="lines">
772
+
773
+
774
+ 49
775
+ 50
776
+ 51
777
+ 52
778
+ 53
779
+ 54
780
+ 55
781
+ 56
782
+ 57
783
+ 58</pre>
784
+ </td>
785
+ <td>
786
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 49</span>
787
+
788
+ <span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>active:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
789
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/service_users</span><span class='tstring_end'>&#39;</span></span>
790
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
791
+ <span class='rbrace'>}</span>
792
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
793
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
794
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:active</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_active'>active</span> <span class='kw'>if</span> <span class='id identifier rubyid_active'>active</span>
795
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
796
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ServiceUser.html#initialize-instance_method" title="NgrokAPI::Models::ServiceUser#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
797
+ <span class='kw'>end</span></pre>
798
+ </td>
799
+ </tr>
800
+ </table>
801
+ </div>
802
+
803
+ <div class="method_details ">
804
+ <h3 class="signature " id="delete-instance_method">
805
+
806
+ #<strong>delete</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
807
+
808
+
809
+
810
+
811
+
812
+ </h3><div class="docstring">
813
+ <div class="discussion">
814
+
815
+ <p>Delete a service user by ID</p>
816
+
817
+ <p><a href="https://ngrok.com/docs/api#api-service-users-delete">ngrok.com/docs/api#api-service-users-delete</a></p>
818
+
819
+
820
+ </div>
821
+ </div>
822
+ <div class="tags">
823
+ <p class="tag_title">Parameters:</p>
824
+ <ul class="param">
825
+
826
+ <li>
827
+
828
+ <span class='name'>id</span>
829
+
830
+
831
+ <span class='type'>(<tt>string</tt>)</span>
832
+
833
+
834
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
835
+
836
+
837
+ &mdash;
838
+ <div class='inline'>
839
+ <p>a resource identifier</p>
840
+ </div>
841
+
842
+ </li>
843
+
844
+ </ul>
845
+
846
+ <p class="tag_title">Returns:</p>
847
+ <ul class="return">
848
+
849
+ <li>
850
+
851
+
852
+ <span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
853
+
854
+
855
+
856
+ &mdash;
857
+ <div class='inline'>
858
+ <p>result from the API request</p>
859
+ </div>
860
+
861
+ </li>
862
+
863
+ </ul>
864
+
865
+ </div><table class="source_code">
866
+ <tr>
867
+ <td>
868
+ <pre class="lines">
869
+
870
+
871
+ 67
872
+ 68
873
+ 69
874
+ 70
875
+ 71
876
+ 72
877
+ 73</pre>
878
+ </td>
879
+ <td>
880
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 67</span>
881
+
882
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
883
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/service_users/%{id}</span><span class='tstring_end'>&#39;</span></span>
884
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
885
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
886
+ <span class='rbrace'>}</span>
887
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
888
+ <span class='kw'>end</span></pre>
889
+ </td>
890
+ </tr>
891
+ </table>
892
+ </div>
893
+
894
+ <div class="method_details ">
895
+ <h3 class="signature " id="delete!-instance_method">
896
+
897
+ #<strong>delete!</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
898
+
899
+
900
+
901
+
902
+
903
+ </h3><div class="docstring">
904
+ <div class="discussion">
905
+
906
+ <p>Delete a service user by ID Throws an exception if API error.</p>
907
+
908
+ <p><a href="https://ngrok.com/docs/api#api-service-users-delete">ngrok.com/docs/api#api-service-users-delete</a></p>
909
+
910
+
911
+ </div>
912
+ </div>
913
+ <div class="tags">
914
+ <p class="tag_title">Parameters:</p>
915
+ <ul class="param">
916
+
917
+ <li>
918
+
919
+ <span class='name'>id</span>
920
+
921
+
922
+ <span class='type'>(<tt>string</tt>)</span>
923
+
924
+
925
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
926
+
927
+
928
+ &mdash;
929
+ <div class='inline'>
930
+ <p>a resource identifier</p>
931
+ </div>
932
+
933
+ </li>
934
+
935
+ </ul>
936
+
937
+ <p class="tag_title">Returns:</p>
938
+ <ul class="return">
939
+
940
+ <li>
941
+
942
+
943
+ <span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
944
+
945
+
946
+
947
+ &mdash;
948
+ <div class='inline'>
949
+ <p>result from the API request</p>
950
+ </div>
951
+
952
+ </li>
953
+
954
+ </ul>
955
+
956
+ </div><table class="source_code">
957
+ <tr>
958
+ <td>
959
+ <pre class="lines">
960
+
961
+
962
+ 83
963
+ 84
964
+ 85
965
+ 86
966
+ 87
967
+ 88
968
+ 89</pre>
969
+ </td>
970
+ <td>
971
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 83</span>
972
+
973
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
974
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/service_users/%{id}</span><span class='tstring_end'>&#39;</span></span>
975
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
976
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
977
+ <span class='rbrace'>}</span>
978
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
979
+ <span class='kw'>end</span></pre>
980
+ </td>
981
+ </tr>
982
+ </table>
983
+ </div>
984
+
985
+ <div class="method_details ">
986
+ <h3 class="signature " id="get-instance_method">
987
+
988
+ #<strong>get</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>
989
+
990
+
991
+
992
+
993
+
994
+ </h3><div class="docstring">
995
+ <div class="discussion">
996
+
997
+ <p>Get the details of a Bot User by ID.</p>
998
+
999
+ <p><a href="https://ngrok.com/docs/api#api-service-users-get">ngrok.com/docs/api#api-service-users-get</a></p>
1000
+
1001
+
1002
+ </div>
1003
+ </div>
1004
+ <div class="tags">
1005
+ <p class="tag_title">Parameters:</p>
1006
+ <ul class="param">
1007
+
1008
+ <li>
1009
+
1010
+ <span class='name'>id</span>
1011
+
1012
+
1013
+ <span class='type'>(<tt>string</tt>)</span>
1014
+
1015
+
1016
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1017
+
1018
+
1019
+ &mdash;
1020
+ <div class='inline'>
1021
+ <p>a resource identifier</p>
1022
+ </div>
1023
+
1024
+ </li>
1025
+
1026
+ </ul>
1027
+
1028
+ <p class="tag_title">Returns:</p>
1029
+ <ul class="return">
1030
+
1031
+ <li>
1032
+
1033
+
1034
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>)</span>
1035
+
1036
+
1037
+
1038
+ &mdash;
1039
+ <div class='inline'>
1040
+ <p>result from the API request</p>
1041
+ </div>
1042
+
1043
+ </li>
1044
+
1045
+ </ul>
1046
+
1047
+ </div><table class="source_code">
1048
+ <tr>
1049
+ <td>
1050
+ <pre class="lines">
1051
+
1052
+
1053
+ 98
1054
+ 99
1055
+ 100
1056
+ 101
1057
+ 102
1058
+ 103
1059
+ 104
1060
+ 105
1061
+ 106</pre>
1062
+ </td>
1063
+ <td>
1064
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 98</span>
1065
+
1066
+ <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1067
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/service_users/%{id}</span><span class='tstring_end'>&#39;</span></span>
1068
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1069
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1070
+ <span class='rbrace'>}</span>
1071
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1072
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1073
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ServiceUser.html#initialize-instance_method" title="NgrokAPI::Models::ServiceUser#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1074
+ <span class='kw'>end</span></pre>
1075
+ </td>
1076
+ </tr>
1077
+ </table>
1078
+ </div>
1079
+
1080
+ <div class="method_details ">
1081
+ <h3 class="signature " id="get!-instance_method">
1082
+
1083
+ #<strong>get!</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>
1084
+
1085
+
1086
+
1087
+
1088
+
1089
+ </h3><div class="docstring">
1090
+ <div class="discussion">
1091
+
1092
+ <p>Get the details of a Bot User by ID. Throws an exception if API error.</p>
1093
+
1094
+ <p><a href="https://ngrok.com/docs/api#api-service-users-get">ngrok.com/docs/api#api-service-users-get</a></p>
1095
+
1096
+
1097
+ </div>
1098
+ </div>
1099
+ <div class="tags">
1100
+ <p class="tag_title">Parameters:</p>
1101
+ <ul class="param">
1102
+
1103
+ <li>
1104
+
1105
+ <span class='name'>id</span>
1106
+
1107
+
1108
+ <span class='type'>(<tt>string</tt>)</span>
1109
+
1110
+
1111
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1112
+
1113
+
1114
+ &mdash;
1115
+ <div class='inline'>
1116
+ <p>a resource identifier</p>
1117
+ </div>
1118
+
1119
+ </li>
1120
+
1121
+ </ul>
1122
+
1123
+ <p class="tag_title">Returns:</p>
1124
+ <ul class="return">
1125
+
1126
+ <li>
1127
+
1128
+
1129
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>)</span>
1130
+
1131
+
1132
+
1133
+ &mdash;
1134
+ <div class='inline'>
1135
+ <p>result from the API request</p>
1136
+ </div>
1137
+
1138
+ </li>
1139
+
1140
+ </ul>
1141
+
1142
+ </div><table class="source_code">
1143
+ <tr>
1144
+ <td>
1145
+ <pre class="lines">
1146
+
1147
+
1148
+ 116
1149
+ 117
1150
+ 118
1151
+ 119
1152
+ 120
1153
+ 121
1154
+ 122
1155
+ 123
1156
+ 124</pre>
1157
+ </td>
1158
+ <td>
1159
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 116</span>
1160
+
1161
+ <span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1162
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/service_users/%{id}</span><span class='tstring_end'>&#39;</span></span>
1163
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1164
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1165
+ <span class='rbrace'>}</span>
1166
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1167
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
1168
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ServiceUser.html#initialize-instance_method" title="NgrokAPI::Models::ServiceUser#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1169
+ <span class='kw'>end</span></pre>
1170
+ </td>
1171
+ </tr>
1172
+ </table>
1173
+ </div>
1174
+
1175
+ <div class="method_details ">
1176
+ <h3 class="signature " id="list-instance_method">
1177
+
1178
+ #<strong>list</strong>(before_id: nil, limit: nil, filter: nil, url: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
1179
+
1180
+
1181
+
1182
+
1183
+
1184
+ </h3><div class="docstring">
1185
+ <div class="discussion">
1186
+
1187
+ <p>List all service users in this account.</p>
1188
+
1189
+ <p><a href="https://ngrok.com/docs/api#api-service-users-list">ngrok.com/docs/api#api-service-users-list</a></p>
1190
+
1191
+
1192
+ </div>
1193
+ </div>
1194
+ <div class="tags">
1195
+ <p class="tag_title">Parameters:</p>
1196
+ <ul class="param">
1197
+
1198
+ <li>
1199
+
1200
+ <span class='name'>before_id</span>
1201
+
1202
+
1203
+ <span class='type'>(<tt>string</tt>)</span>
1204
+
1205
+
1206
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1207
+
1208
+
1209
+ &mdash;
1210
+ <div class='inline'>
1211
+ <p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
1212
+ </div>
1213
+
1214
+ </li>
1215
+
1216
+ <li>
1217
+
1218
+ <span class='name'>limit</span>
1219
+
1220
+
1221
+ <span class='type'>(<tt>string</tt>)</span>
1222
+
1223
+
1224
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1225
+
1226
+
1227
+ &mdash;
1228
+ <div class='inline'>
1229
+ <p>Constrains the number of results in the dataset. See the <code>API Overview &lt;https://ngrok.com/docs/api/index#pagination&gt;</code>_ for details.</p>
1230
+ </div>
1231
+
1232
+ </li>
1233
+
1234
+ <li>
1235
+
1236
+ <span class='name'>filter</span>
1237
+
1238
+
1239
+ <span class='type'>(<tt>string</tt>)</span>
1240
+
1241
+
1242
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1243
+
1244
+
1245
+ &mdash;
1246
+ <div class='inline'>
1247
+ <p>A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as <code>id</code>, <code>metadata</code>, <code>created_at</code>, and more. See ngrok API Filtering for syntax and field details: <code>https://ngrok.com/docs/api/api-filtering &lt;https://ngrok.com/docs/api/api-filtering&gt;</code>_.</p>
1248
+ </div>
1249
+
1250
+ </li>
1251
+
1252
+ <li>
1253
+
1254
+ <span class='name'>url</span>
1255
+
1256
+
1257
+ <span class='type'>(<tt>string</tt>)</span>
1258
+
1259
+
1260
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1261
+
1262
+
1263
+ &mdash;
1264
+ <div class='inline'>
1265
+ <p>optional and mutually exclusive from before_id and limit</p>
1266
+ </div>
1267
+
1268
+ </li>
1269
+
1270
+ </ul>
1271
+
1272
+ <p class="tag_title">Returns:</p>
1273
+ <ul class="return">
1274
+
1275
+ <li>
1276
+
1277
+
1278
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
1279
+
1280
+
1281
+
1282
+ &mdash;
1283
+ <div class='inline'>
1284
+ <p>result from the API request</p>
1285
+ </div>
1286
+
1287
+ </li>
1288
+
1289
+ </ul>
1290
+
1291
+ </div><table class="source_code">
1292
+ <tr>
1293
+ <td>
1294
+ <pre class="lines">
1295
+
1296
+
1297
+ 136
1298
+ 137
1299
+ 138
1300
+ 139
1301
+ 140
1302
+ 141
1303
+ 142
1304
+ 143
1305
+ 144
1306
+ 145
1307
+ 146
1308
+ 147
1309
+ 148
1310
+ 149
1311
+ 150
1312
+ 151
1313
+ 152
1314
+ 153
1315
+ 154
1316
+ 155
1317
+ 156</pre>
1318
+ </td>
1319
+ <td>
1320
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 136</span>
1321
+
1322
+ <span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1323
+ <span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1324
+ <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1325
+ <span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1326
+ <span class='label'>url:</span> <span class='kw'>nil</span>
1327
+ <span class='rparen'>)</span>
1328
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1329
+ <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1330
+ <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1331
+ <span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
1332
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1333
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ServiceUsersClient::PATH (constant)">PATH</a></span></span>
1334
+ <span class='rparen'>)</span>
1335
+
1336
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1337
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1338
+ <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1339
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ServiceUsersClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1340
+ <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span>
1341
+ <span class='rparen'>)</span>
1342
+ <span class='kw'>end</span></pre>
1343
+ </td>
1344
+ </tr>
1345
+ </table>
1346
+ </div>
1347
+
1348
+ <div class="method_details ">
1349
+ <h3 class="signature " id="list!-instance_method">
1350
+
1351
+ #<strong>list!</strong>(before_id: nil, limit: nil, filter: nil, url: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
1352
+
1353
+
1354
+
1355
+
1356
+
1357
+ </h3><div class="docstring">
1358
+ <div class="discussion">
1359
+
1360
+ <p>List all service users in this account. Throws an exception if API error.</p>
1361
+
1362
+ <p><a href="https://ngrok.com/docs/api#api-service-users-list">ngrok.com/docs/api#api-service-users-list</a></p>
1363
+
1364
+
1365
+ </div>
1366
+ </div>
1367
+ <div class="tags">
1368
+ <p class="tag_title">Parameters:</p>
1369
+ <ul class="param">
1370
+
1371
+ <li>
1372
+
1373
+ <span class='name'>before_id</span>
1374
+
1375
+
1376
+ <span class='type'>(<tt>string</tt>)</span>
1377
+
1378
+
1379
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1380
+
1381
+
1382
+ &mdash;
1383
+ <div class='inline'>
1384
+ <p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
1385
+ </div>
1386
+
1387
+ </li>
1388
+
1389
+ <li>
1390
+
1391
+ <span class='name'>limit</span>
1392
+
1393
+
1394
+ <span class='type'>(<tt>string</tt>)</span>
1395
+
1396
+
1397
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1398
+
1399
+
1400
+ &mdash;
1401
+ <div class='inline'>
1402
+ <p>Constrains the number of results in the dataset. See the <code>API Overview &lt;https://ngrok.com/docs/api/index#pagination&gt;</code>_ for details.</p>
1403
+ </div>
1404
+
1405
+ </li>
1406
+
1407
+ <li>
1408
+
1409
+ <span class='name'>filter</span>
1410
+
1411
+
1412
+ <span class='type'>(<tt>string</tt>)</span>
1413
+
1414
+
1415
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1416
+
1417
+
1418
+ &mdash;
1419
+ <div class='inline'>
1420
+ <p>A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as <code>id</code>, <code>metadata</code>, <code>created_at</code>, and more. See ngrok API Filtering for syntax and field details: <code>https://ngrok.com/docs/api/api-filtering &lt;https://ngrok.com/docs/api/api-filtering&gt;</code>_.</p>
1421
+ </div>
1422
+
1423
+ </li>
1424
+
1425
+ <li>
1426
+
1427
+ <span class='name'>url</span>
1428
+
1429
+
1430
+ <span class='type'>(<tt>string</tt>)</span>
1431
+
1432
+
1433
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1434
+
1435
+
1436
+ &mdash;
1437
+ <div class='inline'>
1438
+ <p>optional and mutually exclusive from before_id and limit</p>
1439
+ </div>
1440
+
1441
+ </li>
1442
+
1443
+ </ul>
1444
+
1445
+ <p class="tag_title">Returns:</p>
1446
+ <ul class="return">
1447
+
1448
+ <li>
1449
+
1450
+
1451
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
1452
+
1453
+
1454
+
1455
+ &mdash;
1456
+ <div class='inline'>
1457
+ <p>result from the API request</p>
1458
+ </div>
1459
+
1460
+ </li>
1461
+
1462
+ </ul>
1463
+
1464
+ </div><table class="source_code">
1465
+ <tr>
1466
+ <td>
1467
+ <pre class="lines">
1468
+
1469
+
1470
+ 169
1471
+ 170
1472
+ 171
1473
+ 172
1474
+ 173
1475
+ 174
1476
+ 175
1477
+ 176
1478
+ 177
1479
+ 178
1480
+ 179
1481
+ 180
1482
+ 181
1483
+ 182
1484
+ 183
1485
+ 184
1486
+ 185
1487
+ 186
1488
+ 187
1489
+ 188
1490
+ 189
1491
+ 190
1492
+ 191</pre>
1493
+ </td>
1494
+ <td>
1495
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 169</span>
1496
+
1497
+ <span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
1498
+ <span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1499
+ <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1500
+ <span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1501
+ <span class='label'>url:</span> <span class='kw'>nil</span>
1502
+ <span class='rparen'>)</span>
1503
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1504
+ <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1505
+ <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1506
+ <span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
1507
+ <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
1508
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1509
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ServiceUsersClient::PATH (constant)">PATH</a></span></span>
1510
+ <span class='rparen'>)</span>
1511
+
1512
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1513
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1514
+ <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1515
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ServiceUsersClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1516
+ <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span><span class='comma'>,</span>
1517
+ <span class='label'>danger:</span> <span class='kw'>true</span>
1518
+ <span class='rparen'>)</span>
1519
+ <span class='kw'>end</span></pre>
1520
+ </td>
1521
+ </tr>
1522
+ </table>
1523
+ </div>
1524
+
1525
+ <div class="method_details ">
1526
+ <h3 class="signature " id="update-instance_method">
1527
+
1528
+ #<strong>update</strong>(id: &quot;&quot;, name: nil, active: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>
1529
+
1530
+
1531
+
1532
+
1533
+
1534
+ </h3><div class="docstring">
1535
+ <div class="discussion">
1536
+
1537
+ <p>Update attributes of a service user by ID.</p>
1538
+
1539
+ <p><a href="https://ngrok.com/docs/api#api-service-users-update">ngrok.com/docs/api#api-service-users-update</a></p>
1540
+
1541
+
1542
+ </div>
1543
+ </div>
1544
+ <div class="tags">
1545
+ <p class="tag_title">Parameters:</p>
1546
+ <ul class="param">
1547
+
1548
+ <li>
1549
+
1550
+ <span class='name'>id</span>
1551
+
1552
+
1553
+ <span class='type'>(<tt>string</tt>)</span>
1554
+
1555
+
1556
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1557
+
1558
+
1559
+ </li>
1560
+
1561
+ <li>
1562
+
1563
+ <span class='name'>name</span>
1564
+
1565
+
1566
+ <span class='type'>(<tt>string</tt>)</span>
1567
+
1568
+
1569
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1570
+
1571
+
1572
+ &mdash;
1573
+ <div class='inline'>
1574
+ <p>human-readable name used to identify the service</p>
1575
+ </div>
1576
+
1577
+ </li>
1578
+
1579
+ <li>
1580
+
1581
+ <span class='name'>active</span>
1582
+
1583
+
1584
+ <span class='type'>(<tt>boolean</tt>)</span>
1585
+
1586
+
1587
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1588
+
1589
+
1590
+ &mdash;
1591
+ <div class='inline'>
1592
+ <p>whether or not the service is active</p>
1593
+ </div>
1594
+
1595
+ </li>
1596
+
1597
+ </ul>
1598
+
1599
+ <p class="tag_title">Returns:</p>
1600
+ <ul class="return">
1601
+
1602
+ <li>
1603
+
1604
+
1605
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>)</span>
1606
+
1607
+
1608
+
1609
+ &mdash;
1610
+ <div class='inline'>
1611
+ <p>result from the API request</p>
1612
+ </div>
1613
+
1614
+ </li>
1615
+
1616
+ </ul>
1617
+
1618
+ </div><table class="source_code">
1619
+ <tr>
1620
+ <td>
1621
+ <pre class="lines">
1622
+
1623
+
1624
+ 202
1625
+ 203
1626
+ 204
1627
+ 205
1628
+ 206
1629
+ 207
1630
+ 208
1631
+ 209
1632
+ 210
1633
+ 211
1634
+ 212</pre>
1635
+ </td>
1636
+ <td>
1637
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 202</span>
1638
+
1639
+ <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>name:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>active:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1640
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/service_users/%{id}</span><span class='tstring_end'>&#39;</span></span>
1641
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1642
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1643
+ <span class='rbrace'>}</span>
1644
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1645
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
1646
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:active</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_active'>active</span> <span class='kw'>if</span> <span class='id identifier rubyid_active'>active</span>
1647
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1648
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ServiceUser.html#initialize-instance_method" title="NgrokAPI::Models::ServiceUser#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1649
+ <span class='kw'>end</span></pre>
1650
+ </td>
1651
+ </tr>
1652
+ </table>
1653
+ </div>
1654
+
1655
+ <div class="method_details ">
1656
+ <h3 class="signature " id="update!-instance_method">
1657
+
1658
+ #<strong>update!</strong>(id: &quot;&quot;, name: nil, active: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>
1659
+
1660
+
1661
+
1662
+
1663
+
1664
+ </h3><div class="docstring">
1665
+ <div class="discussion">
1666
+
1667
+ <p>Update attributes of a service user by ID. Throws an exception if API error.</p>
1668
+
1669
+ <p><a href="https://ngrok.com/docs/api#api-service-users-update">ngrok.com/docs/api#api-service-users-update</a></p>
1670
+
1671
+
1672
+ </div>
1673
+ </div>
1674
+ <div class="tags">
1675
+ <p class="tag_title">Parameters:</p>
1676
+ <ul class="param">
1677
+
1678
+ <li>
1679
+
1680
+ <span class='name'>id</span>
1681
+
1682
+
1683
+ <span class='type'>(<tt>string</tt>)</span>
1684
+
1685
+
1686
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1687
+
1688
+
1689
+ </li>
1690
+
1691
+ <li>
1692
+
1693
+ <span class='name'>name</span>
1694
+
1695
+
1696
+ <span class='type'>(<tt>string</tt>)</span>
1697
+
1698
+
1699
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1700
+
1701
+
1702
+ &mdash;
1703
+ <div class='inline'>
1704
+ <p>human-readable name used to identify the service</p>
1705
+ </div>
1706
+
1707
+ </li>
1708
+
1709
+ <li>
1710
+
1711
+ <span class='name'>active</span>
1712
+
1713
+
1714
+ <span class='type'>(<tt>boolean</tt>)</span>
1715
+
1716
+
1717
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1718
+
1719
+
1720
+ &mdash;
1721
+ <div class='inline'>
1722
+ <p>whether or not the service is active</p>
1723
+ </div>
1724
+
1725
+ </li>
1726
+
1727
+ </ul>
1728
+
1729
+ <p class="tag_title">Returns:</p>
1730
+ <ul class="return">
1731
+
1732
+ <li>
1733
+
1734
+
1735
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">NgrokAPI::Models::ServiceUser</a></span></tt>)</span>
1736
+
1737
+
1738
+
1739
+ &mdash;
1740
+ <div class='inline'>
1741
+ <p>result from the API request</p>
1742
+ </div>
1743
+
1744
+ </li>
1745
+
1746
+ </ul>
1747
+
1748
+ </div><table class="source_code">
1749
+ <tr>
1750
+ <td>
1751
+ <pre class="lines">
1752
+
1753
+
1754
+ 224
1755
+ 225
1756
+ 226
1757
+ 227
1758
+ 228
1759
+ 229
1760
+ 230
1761
+ 231
1762
+ 232
1763
+ 233
1764
+ 234</pre>
1765
+ </td>
1766
+ <td>
1767
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/service_users_client.rb', line 224</span>
1768
+
1769
+ <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>name:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>active:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1770
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/service_users/%{id}</span><span class='tstring_end'>&#39;</span></span>
1771
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1772
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1773
+ <span class='rbrace'>}</span>
1774
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1775
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
1776
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:active</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_active'>active</span> <span class='kw'>if</span> <span class='id identifier rubyid_active'>active</span>
1777
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
1778
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/ServiceUser.html" title="NgrokAPI::Models::ServiceUser (class)">ServiceUser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ServiceUser.html#initialize-instance_method" title="NgrokAPI::Models::ServiceUser#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1779
+ <span class='kw'>end</span></pre>
1780
+ </td>
1781
+ </tr>
1782
+ </table>
1783
+ </div>
1784
+
1785
+ </div>
1786
+
1787
+ </div>
1788
+
1789
+ <div id="footer">
1790
+ Generated on Fri Jan 23 21:38:05 2026 by
1791
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1792
+ 0.9.36 (ruby-3.3.10).
1793
+ </div>
1794
+
1795
+ </div>
1796
+ </body>
1797
+ </html>