@ngrok/ngrok-api 0.16.0 → 0.18.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 (294) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/docs/assets/js/search.js +1 -1
  3. package/docs/classes/client.Ngrok.html +44 -30
  4. package/docs/classes/services.APIKeys.html +6 -6
  5. package/docs/classes/services.AbuseReports.html +3 -3
  6. package/docs/classes/services.AgentIngresses.html +6 -6
  7. package/docs/classes/services.ApplicationSessions.html +4 -4
  8. package/docs/classes/services.ApplicationUsers.html +4 -4
  9. package/docs/classes/services.BotUsers.html +6 -6
  10. package/docs/classes/services.CertificateAuthorities.html +7 -7
  11. package/docs/classes/services.Credentials.html +6 -6
  12. package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
  13. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
  14. package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
  15. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
  16. package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
  17. package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
  18. package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
  19. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
  20. package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
  21. package/docs/classes/services.EdgeRouteTrafficPolicyModule.html +4 -4
  22. package/docs/classes/services.EdgeRouteUserAgentFilterModule.html +4 -4
  23. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
  24. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
  25. package/docs/classes/services.EdgesHTTPS.html +6 -6
  26. package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
  27. package/docs/classes/services.EdgesTCP.html +6 -6
  28. package/docs/classes/services.EdgesTLS.html +6 -6
  29. package/docs/classes/services.Endpoints.html +6 -6
  30. package/docs/classes/services.EventDestinations.html +6 -6
  31. package/docs/classes/services.EventSources.html +6 -6
  32. package/docs/classes/services.EventSubscriptions.html +6 -6
  33. package/docs/classes/services.FailoverBackends.html +6 -6
  34. package/docs/classes/services.HTTPResponseBackends.html +6 -6
  35. package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +4 -4
  36. package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +4 -4
  37. package/docs/classes/services.IPPolicies.html +6 -6
  38. package/docs/classes/services.IPPolicyRules.html +6 -6
  39. package/docs/classes/services.IPRestrictions.html +6 -6
  40. package/docs/classes/services.ReservedAddrs.html +6 -6
  41. package/docs/classes/services.ReservedDomains.html +8 -8
  42. package/docs/classes/services.SSHCertificateAuthorities.html +7 -7
  43. package/docs/classes/services.SSHCredentials.html +6 -6
  44. package/docs/classes/services.SSHHostCertificates.html +7 -7
  45. package/docs/classes/services.SSHUserCertificates.html +7 -7
  46. package/docs/classes/services.Secrets.html +6 -6
  47. package/docs/classes/services.ServiceUsers.html +352 -0
  48. package/docs/classes/services.StaticBackends.html +6 -6
  49. package/docs/classes/services.TCPEdgeBackendModule.html +4 -4
  50. package/docs/classes/services.TCPEdgeIPRestrictionModule.html +4 -4
  51. package/docs/classes/services.TCPEdgeTrafficPolicyModule.html +4 -4
  52. package/docs/classes/services.TLSCertificates.html +6 -6
  53. package/docs/classes/services.TLSEdgeBackendModule.html +4 -4
  54. package/docs/classes/services.TLSEdgeIPRestrictionModule.html +4 -4
  55. package/docs/classes/services.TLSEdgeMutualTLSModule.html +4 -4
  56. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +4 -4
  57. package/docs/classes/services.TLSEdgeTrafficPolicyModule.html +4 -4
  58. package/docs/classes/services.TunnelGroupBackends.html +6 -6
  59. package/docs/classes/services.TunnelSessions.html +6 -6
  60. package/docs/classes/services.Tunnels.html +3 -3
  61. package/docs/classes/services.Vaults.html +44 -6
  62. package/docs/classes/services.WeightedBackends.html +6 -6
  63. package/docs/interfaces/client.NgrokConfig.html +2 -2
  64. package/docs/interfaces/datatypes.APIKey.html +7 -7
  65. package/docs/interfaces/datatypes.APIKeyCreate.html +3 -3
  66. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  67. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  68. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  69. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  70. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  71. package/docs/interfaces/datatypes.AbuseReport.html +7 -7
  72. package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
  73. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  74. package/docs/interfaces/datatypes.AgentIngress.html +10 -10
  75. package/docs/interfaces/datatypes.AgentIngressCertJob.html +4 -4
  76. package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +2 -2
  77. package/docs/interfaces/datatypes.AgentIngressCertStatus.html +2 -2
  78. package/docs/interfaces/datatypes.AgentIngressCreate.html +4 -4
  79. package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
  80. package/docs/interfaces/datatypes.AgentIngressUpdate.html +4 -4
  81. package/docs/interfaces/datatypes.ApplicationSession.html +11 -11
  82. package/docs/interfaces/datatypes.ApplicationSessionList.html +3 -3
  83. package/docs/interfaces/datatypes.ApplicationUser.html +10 -10
  84. package/docs/interfaces/datatypes.ApplicationUserList.html +3 -3
  85. package/docs/interfaces/datatypes.BotUser.html +5 -5
  86. package/docs/interfaces/datatypes.BotUserCreate.html +2 -2
  87. package/docs/interfaces/datatypes.BotUserList.html +3 -3
  88. package/docs/interfaces/datatypes.BotUserUpdate.html +3 -3
  89. package/docs/interfaces/datatypes.BrowserSession.html +3 -3
  90. package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
  91. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
  92. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  93. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  94. package/docs/interfaces/datatypes.Credential.html +8 -8
  95. package/docs/interfaces/datatypes.CredentialCreate.html +4 -4
  96. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  97. package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
  98. package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
  99. package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
  100. package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
  101. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
  102. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
  103. package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
  104. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
  105. package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
  106. package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
  107. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
  108. package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
  109. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
  110. package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
  111. package/docs/interfaces/datatypes.EdgeRouteTrafficPolicyReplace.html +3 -3
  112. package/docs/interfaces/datatypes.EdgeRouteUserAgentFilterReplace.html +3 -3
  113. package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
  114. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
  115. package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
  116. package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
  117. package/docs/interfaces/datatypes.EdgeTrafficPolicyReplace.html +2 -2
  118. package/docs/interfaces/datatypes.Endpoint.html +28 -28
  119. package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
  120. package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
  121. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  122. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  123. package/docs/interfaces/datatypes.EndpointCreate.html +8 -8
  124. package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
  125. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  126. package/docs/interfaces/datatypes.EndpointList.html +3 -3
  127. package/docs/interfaces/datatypes.EndpointListArgs.html +28 -14
  128. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  129. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  130. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  131. package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +5 -5
  132. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  133. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
  134. package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +5 -5
  135. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  136. package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +5 -5
  137. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  138. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +8 -8
  139. package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +5 -5
  140. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  141. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  142. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  143. package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
  144. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
  145. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  146. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
  147. package/docs/interfaces/datatypes.EndpointTrafficPolicy.html +2 -2
  148. package/docs/interfaces/datatypes.EndpointUpdate.html +8 -8
  149. package/docs/interfaces/datatypes.EndpointUserAgentFilter.html +3 -3
  150. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +3 -3
  151. package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
  152. package/docs/interfaces/datatypes.Error.html +4 -4
  153. package/docs/interfaces/datatypes.EventDestination.html +7 -7
  154. package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
  155. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  156. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  157. package/docs/interfaces/datatypes.EventSource.html +2 -2
  158. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  159. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  160. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  161. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  162. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  163. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  164. package/docs/interfaces/datatypes.EventSubscription.html +7 -7
  165. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +4 -4
  166. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  167. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
  168. package/docs/interfaces/datatypes.EventTarget.html +5 -5
  169. package/docs/interfaces/datatypes.EventTargetAzureLogsIngestion.html +6 -6
  170. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  171. package/docs/interfaces/datatypes.EventTargetDatadog.html +4 -4
  172. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  173. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  174. package/docs/interfaces/datatypes.FailoverBackend.html +6 -6
  175. package/docs/interfaces/datatypes.FailoverBackendCreate.html +3 -3
  176. package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
  177. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
  178. package/docs/interfaces/datatypes.FilteredPaging.html +190 -0
  179. package/docs/interfaces/datatypes.HTTPResponseBackend.html +8 -8
  180. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +5 -5
  181. package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
  182. package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
  183. package/docs/interfaces/datatypes.HTTPSEdge.html +9 -9
  184. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +5 -5
  185. package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
  186. package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +21 -21
  187. package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +18 -18
  188. package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +19 -19
  189. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
  190. package/docs/interfaces/datatypes.IPPolicy.html +5 -5
  191. package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -2
  192. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  193. package/docs/interfaces/datatypes.IPPolicyRule.html +8 -8
  194. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +5 -5
  195. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  196. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  197. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  198. package/docs/interfaces/datatypes.IPRestriction.html +8 -8
  199. package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
  200. package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
  201. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  202. package/docs/interfaces/datatypes.IdentityProvider.html +2 -2
  203. package/docs/interfaces/datatypes.Item.html +1 -1
  204. package/docs/interfaces/datatypes.ItemPaging.html +195 -0
  205. package/docs/interfaces/datatypes.Location.html +4 -4
  206. package/docs/interfaces/datatypes.Paging.html +2 -2
  207. package/docs/interfaces/datatypes.Ref.html +2 -2
  208. package/docs/interfaces/datatypes.ReservedAddr.html +7 -7
  209. package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -3
  210. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  211. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
  212. package/docs/interfaces/datatypes.ReservedDomain.html +12 -12
  213. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -4
  214. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  215. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
  216. package/docs/interfaces/datatypes.ReservedDomainCreate.html +6 -6
  217. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  218. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
  219. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
  220. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
  221. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  222. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  223. package/docs/interfaces/datatypes.SSHCredential.html +8 -8
  224. package/docs/interfaces/datatypes.SSHCredentialCreate.html +5 -5
  225. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  226. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
  227. package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
  228. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
  229. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  230. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  231. package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
  232. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
  233. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  234. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  235. package/docs/interfaces/datatypes.Secret.html +29 -10
  236. package/docs/interfaces/datatypes.SecretCreate.html +24 -5
  237. package/docs/interfaces/datatypes.SecretList.html +3 -3
  238. package/docs/interfaces/datatypes.SecretUpdate.html +5 -5
  239. package/docs/interfaces/datatypes.ServiceUser.html +243 -0
  240. package/docs/interfaces/datatypes.ServiceUserCreate.html +186 -0
  241. package/docs/interfaces/datatypes.ServiceUserList.html +205 -0
  242. package/docs/interfaces/datatypes.ServiceUserUpdate.html +200 -0
  243. package/docs/interfaces/datatypes.StaticBackend.html +7 -7
  244. package/docs/interfaces/datatypes.StaticBackendCreate.html +4 -4
  245. package/docs/interfaces/datatypes.StaticBackendList.html +3 -3
  246. package/docs/interfaces/datatypes.StaticBackendTLS.html +1 -1
  247. package/docs/interfaces/datatypes.StaticBackendUpdate.html +5 -5
  248. package/docs/interfaces/datatypes.TCPEdge.html +9 -9
  249. package/docs/interfaces/datatypes.TCPEdgeCreate.html +6 -6
  250. package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
  251. package/docs/interfaces/datatypes.TCPEdgeUpdate.html +7 -7
  252. package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
  253. package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
  254. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  255. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  256. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  257. package/docs/interfaces/datatypes.TLSEdge.html +11 -11
  258. package/docs/interfaces/datatypes.TLSEdgeCreate.html +8 -8
  259. package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
  260. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +9 -9
  261. package/docs/interfaces/datatypes.Tunnel.html +11 -11
  262. package/docs/interfaces/datatypes.TunnelGroupBackend.html +7 -7
  263. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +3 -3
  264. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
  265. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
  266. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  267. package/docs/interfaces/datatypes.TunnelSession.html +10 -10
  268. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  269. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  270. package/docs/interfaces/datatypes.UserAgent.html +6 -6
  271. package/docs/interfaces/datatypes.Vault.html +9 -9
  272. package/docs/interfaces/datatypes.VaultCreate.html +3 -3
  273. package/docs/interfaces/datatypes.VaultList.html +3 -3
  274. package/docs/interfaces/datatypes.VaultUpdate.html +4 -4
  275. package/docs/interfaces/datatypes.WeightedBackend.html +6 -6
  276. package/docs/interfaces/datatypes.WeightedBackendCreate.html +3 -3
  277. package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
  278. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
  279. package/docs/modules/datatypes.html +24 -0
  280. package/docs/modules/services.html +4 -0
  281. package/lib/client.d.ts +1 -0
  282. package/lib/client.d.ts.map +1 -1
  283. package/lib/client.js +2 -1
  284. package/lib/client.js.map +1 -1
  285. package/lib/datatypes.d.ts +54 -5
  286. package/lib/datatypes.d.ts.map +1 -1
  287. package/lib/services.d.ts +37 -4
  288. package/lib/services.d.ts.map +1 -1
  289. package/lib/services.js +190 -33
  290. package/lib/services.js.map +1 -1
  291. package/package.json +1 -1
  292. package/src/client.ts +3 -1
  293. package/src/datatypes.ts +60 -5
  294. package/src/services.ts +212 -38
package/docs/interfaces/datatypes.ServiceUserCreate.html ADDED
@@ -0,0 +1,186 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>ServiceUserCreate | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.ServiceUserCreate.html">ServiceUserCreate</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface ServiceUserCreate</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">ServiceUserCreate</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ServiceUserCreate.html#active" class="tsd-kind-icon">active</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ServiceUserCreate.html#name" class="tsd-kind-icon">name</a></li>
88
+ </ul>
89
+ </section>
90
+ </div>
91
+ </section>
92
+ </section>
93
+ <section class="tsd-panel-group tsd-member-group ">
94
+ <h2>Properties</h2>
95
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
96
+ <a name="active" class="tsd-anchor"></a>
97
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> active</h3>
98
+ <div class="tsd-signature tsd-kind-icon">active<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
99
+ <aside class="tsd-sources">
100
+ <ul>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2129">datatypes.ts:2129</a></li>
102
+ </ul>
103
+ </aside>
104
+ <div class="tsd-comment tsd-typography">
105
+ <div class="lead">
106
+ <p>whether or not the service is active</p>
107
+ </div>
108
+ </div>
109
+ </section>
110
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
111
+ <a name="name" class="tsd-anchor"></a>
112
+ <h3>name</h3>
113
+ <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
114
+ <aside class="tsd-sources">
115
+ <ul>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2127">datatypes.ts:2127</a></li>
117
+ </ul>
118
+ </aside>
119
+ <div class="tsd-comment tsd-typography">
120
+ <div class="lead">
121
+ <p>human-readable name used to identify the service</p>
122
+ </div>
123
+ </div>
124
+ </section>
125
+ </section>
126
+ </div>
127
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
128
+ <nav class="tsd-navigation primary">
129
+ <ul>
130
+ <li class=" ">
131
+ <a href="../modules.html">Modules</a>
132
+ </li>
133
+ <li class=" tsd-kind-module">
134
+ <a href="../modules/client.html">client</a>
135
+ </li>
136
+ <li class="current tsd-kind-module">
137
+ <a href="../modules/datatypes.html">datatypes</a>
138
+ </li>
139
+ <li class=" tsd-kind-module">
140
+ <a href="../modules/services.html">services</a>
141
+ </li>
142
+ </ul>
143
+ </nav>
144
+ <nav class="tsd-navigation secondary menu-sticky">
145
+ <ul class="before-current">
146
+ </ul>
147
+ <ul class="current">
148
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
149
+ <a href="datatypes.ServiceUserCreate.html" class="tsd-kind-icon">Service<wbr>User<wbr>Create</a>
150
+ <ul>
151
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
152
+ <a href="datatypes.ServiceUserCreate.html#active" class="tsd-kind-icon">active</a>
153
+ </li>
154
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
155
+ <a href="datatypes.ServiceUserCreate.html#name" class="tsd-kind-icon">name</a>
156
+ </li>
157
+ </ul>
158
+ </li>
159
+ </ul>
160
+ <ul class="after-current">
161
+ </ul>
162
+ </nav>
163
+ </div>
164
+ </div>
165
+ </div>
166
+ <footer class="with-border-bottom">
167
+ <div class="container">
168
+ <h2>Legend</h2>
169
+ <div class="tsd-legend-group">
170
+ <ul class="tsd-legend">
171
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
172
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
173
+ </ul>
174
+ <ul class="tsd-legend">
175
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
176
+ </ul>
177
+ </div>
178
+ </div>
179
+ </footer>
180
+ <div class="container tsd-generator">
181
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
182
+ </div>
183
+ <div class="overlay"></div>
184
+ <script src="../assets/js/main.js"></script>
185
+ </body>
186
+ </html>
package/docs/interfaces/datatypes.ServiceUserList.html ADDED
@@ -0,0 +1,205 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>ServiceUserList | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.ServiceUserList.html">ServiceUserList</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface ServiceUserList</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">ServiceUserList</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ServiceUserList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ServiceUserList.html#serviceUsers" class="tsd-kind-icon">service<wbr>Users</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ServiceUserList.html#uri" class="tsd-kind-icon">uri</a></li>
89
+ </ul>
90
+ </section>
91
+ </div>
92
+ </section>
93
+ </section>
94
+ <section class="tsd-panel-group tsd-member-group ">
95
+ <h2>Properties</h2>
96
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
97
+ <a name="nextPageUri" class="tsd-anchor"></a>
98
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> next<wbr>Page<wbr>Uri</h3>
99
+ <div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
+ <aside class="tsd-sources">
101
+ <ul>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2146">datatypes.ts:2146</a></li>
103
+ </ul>
104
+ </aside>
105
+ <div class="tsd-comment tsd-typography">
106
+ <div class="lead">
107
+ <p>URI of the next page, or null if there is no next page</p>
108
+ </div>
109
+ </div>
110
+ </section>
111
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
112
+ <a name="serviceUsers" class="tsd-anchor"></a>
113
+ <h3>service<wbr>Users</h3>
114
+ <div class="tsd-signature tsd-kind-icon">service<wbr>Users<span class="tsd-signature-symbol">:</span> <a href="datatypes.ServiceUser.html" class="tsd-signature-type" data-tsd-kind="Interface">ServiceUser</a><span class="tsd-signature-symbol">[]</span></div>
115
+ <aside class="tsd-sources">
116
+ <ul>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2142">datatypes.ts:2142</a></li>
118
+ </ul>
119
+ </aside>
120
+ <div class="tsd-comment tsd-typography">
121
+ <div class="lead">
122
+ <p>the list of all service users on this account</p>
123
+ </div>
124
+ </div>
125
+ </section>
126
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
127
+ <a name="uri" class="tsd-anchor"></a>
128
+ <h3>uri</h3>
129
+ <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130
+ <aside class="tsd-sources">
131
+ <ul>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2144">datatypes.ts:2144</a></li>
133
+ </ul>
134
+ </aside>
135
+ <div class="tsd-comment tsd-typography">
136
+ <div class="lead">
137
+ <p>URI of the service users list API resource</p>
138
+ </div>
139
+ </div>
140
+ </section>
141
+ </section>
142
+ </div>
143
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
144
+ <nav class="tsd-navigation primary">
145
+ <ul>
146
+ <li class=" ">
147
+ <a href="../modules.html">Modules</a>
148
+ </li>
149
+ <li class=" tsd-kind-module">
150
+ <a href="../modules/client.html">client</a>
151
+ </li>
152
+ <li class="current tsd-kind-module">
153
+ <a href="../modules/datatypes.html">datatypes</a>
154
+ </li>
155
+ <li class=" tsd-kind-module">
156
+ <a href="../modules/services.html">services</a>
157
+ </li>
158
+ </ul>
159
+ </nav>
160
+ <nav class="tsd-navigation secondary menu-sticky">
161
+ <ul class="before-current">
162
+ </ul>
163
+ <ul class="current">
164
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
165
+ <a href="datatypes.ServiceUserList.html" class="tsd-kind-icon">Service<wbr>User<wbr>List</a>
166
+ <ul>
167
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
168
+ <a href="datatypes.ServiceUserList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a>
169
+ </li>
170
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
171
+ <a href="datatypes.ServiceUserList.html#serviceUsers" class="tsd-kind-icon">service<wbr>Users</a>
172
+ </li>
173
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
174
+ <a href="datatypes.ServiceUserList.html#uri" class="tsd-kind-icon">uri</a>
175
+ </li>
176
+ </ul>
177
+ </li>
178
+ </ul>
179
+ <ul class="after-current">
180
+ </ul>
181
+ </nav>
182
+ </div>
183
+ </div>
184
+ </div>
185
+ <footer class="with-border-bottom">
186
+ <div class="container">
187
+ <h2>Legend</h2>
188
+ <div class="tsd-legend-group">
189
+ <ul class="tsd-legend">
190
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
191
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
192
+ </ul>
193
+ <ul class="tsd-legend">
194
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
195
+ </ul>
196
+ </div>
197
+ </div>
198
+ </footer>
199
+ <div class="container tsd-generator">
200
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
201
+ </div>
202
+ <div class="overlay"></div>
203
+ <script src="../assets/js/main.js"></script>
204
+ </body>
205
+ </html>
package/docs/interfaces/datatypes.ServiceUserUpdate.html ADDED
@@ -0,0 +1,200 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>ServiceUserUpdate | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.ServiceUserUpdate.html">ServiceUserUpdate</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface ServiceUserUpdate</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">ServiceUserUpdate</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ServiceUserUpdate.html#active" class="tsd-kind-icon">active</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ServiceUserUpdate.html#id" class="tsd-kind-icon">id</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ServiceUserUpdate.html#name" class="tsd-kind-icon">name</a></li>
89
+ </ul>
90
+ </section>
91
+ </div>
92
+ </section>
93
+ </section>
94
+ <section class="tsd-panel-group tsd-member-group ">
95
+ <h2>Properties</h2>
96
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
97
+ <a name="active" class="tsd-anchor"></a>
98
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> active</h3>
99
+ <div class="tsd-signature tsd-kind-icon">active<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
100
+ <aside class="tsd-sources">
101
+ <ul>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2137">datatypes.ts:2137</a></li>
103
+ </ul>
104
+ </aside>
105
+ <div class="tsd-comment tsd-typography">
106
+ <div class="lead">
107
+ <p>whether or not the service is active</p>
108
+ </div>
109
+ </div>
110
+ </section>
111
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
112
+ <a name="id" class="tsd-anchor"></a>
113
+ <h3>id</h3>
114
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
115
+ <aside class="tsd-sources">
116
+ <ul>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2133">datatypes.ts:2133</a></li>
118
+ </ul>
119
+ </aside>
120
+ </section>
121
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
122
+ <a name="name" class="tsd-anchor"></a>
123
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3>
124
+ <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
125
+ <aside class="tsd-sources">
126
+ <ul>
127
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2135">datatypes.ts:2135</a></li>
128
+ </ul>
129
+ </aside>
130
+ <div class="tsd-comment tsd-typography">
131
+ <div class="lead">
132
+ <p>human-readable name used to identify the service</p>
133
+ </div>
134
+ </div>
135
+ </section>
136
+ </section>
137
+ </div>
138
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
139
+ <nav class="tsd-navigation primary">
140
+ <ul>
141
+ <li class=" ">
142
+ <a href="../modules.html">Modules</a>
143
+ </li>
144
+ <li class=" tsd-kind-module">
145
+ <a href="../modules/client.html">client</a>
146
+ </li>
147
+ <li class="current tsd-kind-module">
148
+ <a href="../modules/datatypes.html">datatypes</a>
149
+ </li>
150
+ <li class=" tsd-kind-module">
151
+ <a href="../modules/services.html">services</a>
152
+ </li>
153
+ </ul>
154
+ </nav>
155
+ <nav class="tsd-navigation secondary menu-sticky">
156
+ <ul class="before-current">
157
+ </ul>
158
+ <ul class="current">
159
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
160
+ <a href="datatypes.ServiceUserUpdate.html" class="tsd-kind-icon">Service<wbr>User<wbr>Update</a>
161
+ <ul>
162
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
163
+ <a href="datatypes.ServiceUserUpdate.html#active" class="tsd-kind-icon">active</a>
164
+ </li>
165
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
166
+ <a href="datatypes.ServiceUserUpdate.html#id" class="tsd-kind-icon">id</a>
167
+ </li>
168
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
169
+ <a href="datatypes.ServiceUserUpdate.html#name" class="tsd-kind-icon">name</a>
170
+ </li>
171
+ </ul>
172
+ </li>
173
+ </ul>
174
+ <ul class="after-current">
175
+ </ul>
176
+ </nav>
177
+ </div>
178
+ </div>
179
+ </div>
180
+ <footer class="with-border-bottom">
181
+ <div class="container">
182
+ <h2>Legend</h2>
183
+ <div class="tsd-legend-group">
184
+ <ul class="tsd-legend">
185
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
186
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
187
+ </ul>
188
+ <ul class="tsd-legend">
189
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
190
+ </ul>
191
+ </div>
192
+ </div>
193
+ </footer>
194
+ <div class="container tsd-generator">
195
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
196
+ </div>
197
+ <div class="overlay"></div>
198
+ <script src="../assets/js/main.js"></script>
199
+ </body>
200
+ </html>
package/docs/interfaces/datatypes.StaticBackend.html CHANGED
@@ -103,7 +103,7 @@
103
103
  <div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
104
104
  <aside class="tsd-sources">
105
105
  <ul>
106
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L431">datatypes.ts:431</a></li>
106
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L444">datatypes.ts:444</a></li>
107
107
  </ul>
108
108
  </aside>
109
109
  <div class="tsd-comment tsd-typography">
@@ -118,7 +118,7 @@
118
118
  <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
119
119
  <aside class="tsd-sources">
120
120
  <ul>
121
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L425">datatypes.ts:425</a></li>
121
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L438">datatypes.ts:438</a></li>
122
122
  </ul>
123
123
  </aside>
124
124
  <div class="tsd-comment tsd-typography">
@@ -133,7 +133,7 @@
133
133
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
134
134
  <aside class="tsd-sources">
135
135
  <ul>
136
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L427">datatypes.ts:427</a></li>
136
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L440">datatypes.ts:440</a></li>
137
137
  </ul>
138
138
  </aside>
139
139
  <div class="tsd-comment tsd-typography">
@@ -148,7 +148,7 @@
148
148
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
149
149
  <aside class="tsd-sources">
150
150
  <ul>
151
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L421">datatypes.ts:421</a></li>
151
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L434">datatypes.ts:434</a></li>
152
152
  </ul>
153
153
  </aside>
154
154
  <div class="tsd-comment tsd-typography">
@@ -163,7 +163,7 @@
163
163
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
164
164
  <aside class="tsd-sources">
165
165
  <ul>
166
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L429">datatypes.ts:429</a></li>
166
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L442">datatypes.ts:442</a></li>
167
167
  </ul>
168
168
  </aside>
169
169
  <div class="tsd-comment tsd-typography">
@@ -178,7 +178,7 @@
178
178
  <div class="tsd-signature tsd-kind-icon">tls<span class="tsd-signature-symbol">:</span> <a href="datatypes.StaticBackendTLS.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackendTLS</a></div>
179
179
  <aside class="tsd-sources">
180
180
  <ul>
181
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L433">datatypes.ts:433</a></li>
181
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L446">datatypes.ts:446</a></li>
182
182
  </ul>
183
183
  </aside>
184
184
  <div class="tsd-comment tsd-typography">
@@ -193,7 +193,7 @@
193
193
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
194
194
  <aside class="tsd-sources">
195
195
  <ul>
196
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L423">datatypes.ts:423</a></li>
196
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L436">datatypes.ts:436</a></li>
197
197
  </ul>
198
198
  </aside>
199
199
  <div class="tsd-comment tsd-typography">