@ngrok/ngrok-api 0.9.0 → 0.11.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 (293) hide show
  1. package/.eslintignore +2 -0
  2. package/.eslintrc.js +2 -0
  3. package/.prettierrc.js +2 -0
  4. package/CHANGELOG.md +16 -3
  5. package/CODE_OF_CONDUCT.md +45 -0
  6. package/README.md +9 -3
  7. package/docs/assets/js/search.js +1 -1
  8. package/docs/classes/client.Ngrok.html +82 -28
  9. package/docs/classes/services.APIKeys.html +20 -11
  10. package/docs/classes/services.AbuseReports.html +5 -5
  11. package/docs/classes/services.AgentIngresses.html +20 -11
  12. package/docs/classes/services.ApplicationSessions.html +288 -0
  13. package/docs/classes/services.ApplicationUsers.html +288 -0
  14. package/docs/classes/services.BotUsers.html +352 -0
  15. package/docs/classes/services.CertificateAuthorities.html +20 -11
  16. package/docs/classes/services.Credentials.html +21 -12
  17. package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
  18. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
  19. package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
  20. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
  21. package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
  22. package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
  23. package/docs/classes/services.EdgeRoutePolicyModule.html +270 -0
  24. package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
  25. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
  26. package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
  27. package/docs/classes/services.EdgeRouteUserAgentFilterModule.html +270 -0
  28. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
  29. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
  30. package/docs/classes/services.EdgesHTTPS.html +20 -11
  31. package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
  32. package/docs/classes/services.EdgesTCP.html +20 -11
  33. package/docs/classes/services.EdgesTLS.html +20 -11
  34. package/docs/classes/services.Endpoints.html +15 -6
  35. package/docs/classes/services.EventDestinations.html +21 -12
  36. package/docs/classes/services.EventSources.html +6 -6
  37. package/docs/classes/services.EventSubscriptions.html +20 -11
  38. package/docs/classes/services.FailoverBackends.html +20 -11
  39. package/docs/classes/services.HTTPResponseBackends.html +20 -11
  40. package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +8 -8
  41. package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +8 -8
  42. package/docs/classes/services.IPPolicies.html +20 -11
  43. package/docs/classes/services.IPPolicyRules.html +20 -11
  44. package/docs/classes/services.IPRestrictions.html +20 -11
  45. package/docs/classes/services.ReservedAddrs.html +20 -11
  46. package/docs/classes/services.ReservedDomains.html +26 -17
  47. package/docs/classes/services.SSHCertificateAuthorities.html +20 -11
  48. package/docs/classes/services.SSHCredentials.html +20 -11
  49. package/docs/classes/services.SSHHostCertificates.html +20 -11
  50. package/docs/classes/services.SSHUserCertificates.html +20 -11
  51. package/docs/classes/services.StaticBackends.html +360 -0
  52. package/docs/classes/services.TCPEdgeBackendModule.html +8 -8
  53. package/docs/classes/services.TCPEdgeIPRestrictionModule.html +8 -8
  54. package/docs/classes/services.TCPEdgePolicyModule.html +270 -0
  55. package/docs/classes/services.TLSCertificates.html +20 -11
  56. package/docs/classes/services.TLSEdgeBackendModule.html +8 -8
  57. package/docs/classes/services.TLSEdgeIPRestrictionModule.html +8 -8
  58. package/docs/classes/services.TLSEdgeMutualTLSModule.html +8 -8
  59. package/docs/classes/services.TLSEdgePolicyModule.html +270 -0
  60. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +8 -8
  61. package/docs/classes/services.TunnelGroupBackends.html +20 -11
  62. package/docs/classes/services.TunnelSessions.html +22 -13
  63. package/docs/classes/services.Tunnels.html +15 -6
  64. package/docs/classes/services.WeightedBackends.html +20 -11
  65. package/docs/index.html +8 -3
  66. package/docs/interfaces/client.NgrokConfig.html +3 -3
  67. package/docs/interfaces/datatypes.APIKey.html +28 -9
  68. package/docs/interfaces/datatypes.APIKeyCreate.html +23 -4
  69. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  70. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  71. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  72. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  73. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  74. package/docs/interfaces/datatypes.AbuseReport.html +9 -9
  75. package/docs/interfaces/datatypes.AbuseReportCreate.html +3 -3
  76. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  77. package/docs/interfaces/datatypes.AgentIngress.html +49 -11
  78. package/docs/interfaces/datatypes.AgentIngressCertJob.html +224 -0
  79. package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +186 -0
  80. package/docs/interfaces/datatypes.AgentIngressCertStatus.html +186 -0
  81. package/docs/interfaces/datatypes.AgentIngressCreate.html +24 -5
  82. package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
  83. package/docs/interfaces/datatypes.AgentIngressUpdate.html +22 -3
  84. package/docs/interfaces/datatypes.ApplicationSession.html +357 -0
  85. package/docs/interfaces/datatypes.ApplicationSessionList.html +205 -0
  86. package/docs/interfaces/datatypes.ApplicationUser.html +338 -0
  87. package/docs/interfaces/datatypes.ApplicationUserList.html +205 -0
  88. package/docs/interfaces/datatypes.BotUser.html +243 -0
  89. package/docs/interfaces/datatypes.BotUserCreate.html +186 -0
  90. package/docs/interfaces/datatypes.BotUserList.html +205 -0
  91. package/docs/interfaces/datatypes.BotUserUpdate.html +200 -0
  92. package/docs/interfaces/datatypes.BrowserSession.html +205 -0
  93. package/docs/interfaces/datatypes.CertificateAuthority.html +16 -16
  94. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +5 -5
  95. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  96. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  97. package/docs/interfaces/datatypes.Credential.html +30 -11
  98. package/docs/interfaces/datatypes.CredentialCreate.html +25 -6
  99. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  100. package/docs/interfaces/datatypes.CredentialUpdate.html +5 -5
  101. package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
  102. package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
  103. package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
  104. package/docs/interfaces/datatypes.EdgePolicyReplace.html +176 -0
  105. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
  106. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
  107. package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
  108. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
  109. package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
  110. package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
  111. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
  112. package/docs/interfaces/datatypes.EdgeRoutePolicyReplace.html +190 -0
  113. package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
  114. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
  115. package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
  116. package/docs/interfaces/datatypes.EdgeRouteUserAgentFilterReplace.html +190 -0
  117. package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
  118. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
  119. package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
  120. package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
  121. package/docs/interfaces/datatypes.Endpoint.html +19 -19
  122. package/docs/interfaces/datatypes.EndpointAction.html +186 -0
  123. package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
  124. package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
  125. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  126. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  127. package/docs/interfaces/datatypes.EndpointIPPolicy.html +7 -2
  128. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  129. package/docs/interfaces/datatypes.EndpointList.html +3 -3
  130. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  131. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  132. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  133. package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +218 -0
  134. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  135. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +12 -12
  136. package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +218 -0
  137. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  138. package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +218 -0
  139. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  140. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +80 -4
  141. package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +218 -0
  142. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  143. package/docs/interfaces/datatypes.EndpointPolicy.html +205 -0
  144. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  145. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  146. package/docs/interfaces/datatypes.EndpointRule.html +205 -0
  147. package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
  148. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
  149. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  150. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
  151. package/docs/interfaces/datatypes.EndpointUserAgentFilter.html +190 -0
  152. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
  153. package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
  154. package/docs/interfaces/datatypes.Error.html +4 -4
  155. package/docs/interfaces/datatypes.EventDestination.html +10 -10
  156. package/docs/interfaces/datatypes.EventDestinationCreate.html +6 -6
  157. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  158. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  159. package/docs/interfaces/datatypes.EventSource.html +2 -2
  160. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  161. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  162. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  163. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  164. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  165. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  166. package/docs/interfaces/datatypes.EventSubscription.html +10 -10
  167. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +6 -6
  168. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  169. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
  170. package/docs/interfaces/datatypes.EventTarget.html +22 -3
  171. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  172. package/docs/interfaces/datatypes.EventTargetDatadog.html +224 -0
  173. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  174. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  175. package/docs/interfaces/datatypes.FailoverBackend.html +9 -9
  176. package/docs/interfaces/datatypes.FailoverBackendCreate.html +5 -5
  177. package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
  178. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
  179. package/docs/interfaces/datatypes.HTTPResponseBackend.html +11 -11
  180. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +7 -7
  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 +12 -12
  184. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +7 -7
  185. package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
  186. package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +55 -22
  187. package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +51 -18
  188. package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +52 -19
  189. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
  190. package/docs/interfaces/datatypes.IPPolicy.html +8 -8
  191. package/docs/interfaces/datatypes.IPPolicyCreate.html +4 -4
  192. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  193. package/docs/interfaces/datatypes.IPPolicyRule.html +11 -11
  194. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +7 -7
  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 +11 -11
  199. package/docs/interfaces/datatypes.IPRestrictionCreate.html +7 -7
  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 +186 -0
  203. package/docs/interfaces/datatypes.Item.html +1 -1
  204. package/docs/interfaces/datatypes.Location.html +224 -0
  205. package/docs/interfaces/datatypes.Paging.html +2 -2
  206. package/docs/interfaces/datatypes.Ref.html +2 -2
  207. package/docs/interfaces/datatypes.ReservedAddr.html +10 -10
  208. package/docs/interfaces/datatypes.ReservedAddrCreate.html +5 -5
  209. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  210. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
  211. package/docs/interfaces/datatypes.ReservedDomain.html +17 -17
  212. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +6 -6
  213. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  214. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +3 -3
  215. package/docs/interfaces/datatypes.ReservedDomainCreate.html +19 -19
  216. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  217. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
  218. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +10 -10
  219. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +7 -7
  220. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  221. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  222. package/docs/interfaces/datatypes.SSHCredential.html +30 -11
  223. package/docs/interfaces/datatypes.SSHCredentialCreate.html +26 -7
  224. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  225. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +5 -5
  226. package/docs/interfaces/datatypes.SSHHostCertificate.html +17 -17
  227. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +11 -11
  228. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  229. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  230. package/docs/interfaces/datatypes.SSHUserCertificate.html +19 -19
  231. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +13 -13
  232. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  233. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  234. package/docs/interfaces/datatypes.StaticBackend.html +281 -0
  235. package/docs/interfaces/datatypes.StaticBackendCreate.html +224 -0
  236. package/docs/interfaces/datatypes.StaticBackendList.html +205 -0
  237. package/docs/interfaces/datatypes.StaticBackendTLS.html +167 -0
  238. package/docs/interfaces/datatypes.StaticBackendUpdate.html +238 -0
  239. package/docs/interfaces/datatypes.TCPEdge.html +30 -11
  240. package/docs/interfaces/datatypes.TCPEdgeCreate.html +26 -7
  241. package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
  242. package/docs/interfaces/datatypes.TCPEdgeUpdate.html +25 -6
  243. package/docs/interfaces/datatypes.TLSCertificate.html +28 -28
  244. package/docs/interfaces/datatypes.TLSCertificateCreate.html +8 -8
  245. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  246. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  247. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  248. package/docs/interfaces/datatypes.TLSEdge.html +32 -13
  249. package/docs/interfaces/datatypes.TLSEdgeCreate.html +28 -9
  250. package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
  251. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +27 -8
  252. package/docs/interfaces/datatypes.Tunnel.html +17 -17
  253. package/docs/interfaces/datatypes.TunnelGroupBackend.html +10 -10
  254. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +5 -5
  255. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
  256. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
  257. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  258. package/docs/interfaces/datatypes.TunnelSession.html +12 -12
  259. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  260. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  261. package/docs/interfaces/datatypes.UserAgent.html +262 -0
  262. package/docs/interfaces/datatypes.WeightedBackend.html +9 -9
  263. package/docs/interfaces/datatypes.WeightedBackendCreate.html +5 -5
  264. package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
  265. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
  266. package/docs/modules/datatypes.html +128 -0
  267. package/docs/modules/services.html +32 -0
  268. package/jest.config.js +2 -0
  269. package/lib/client.d.ts +17 -8
  270. package/lib/client.d.ts.map +1 -1
  271. package/lib/client.js +92 -119
  272. package/lib/client.js.map +1 -1
  273. package/lib/datatypes.d.ts +539 -204
  274. package/lib/datatypes.d.ts.map +1 -1
  275. package/lib/datatypes.js +4 -3
  276. package/lib/datatypes.js.map +1 -1
  277. package/lib/index.d.ts.map +1 -1
  278. package/lib/index.js +16 -28
  279. package/lib/index.js.map +1 -1
  280. package/lib/services.d.ts +254 -126
  281. package/lib/services.d.ts.map +1 -1
  282. package/lib/services.js +3613 -3356
  283. package/lib/services.js.map +1 -1
  284. package/lib/util.d.ts.map +1 -1
  285. package/lib/util.js +35 -34
  286. package/lib/util.js.map +1 -1
  287. package/package.json +4 -3
  288. package/src/client.ts +28 -33
  289. package/src/datatypes.ts +576 -207
  290. package/src/index.ts +2 -0
  291. package/src/services.ts +1136 -553
  292. package/src/util.ts +2 -0
  293. package/test/apikey.test.js +62 -63
@@ -0,0 +1,360 @@
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>StaticBackends | @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/services.html">services</a>
59
+ </li>
60
+ <li>
61
+ <a href="services.StaticBackends.html">StaticBackends</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Class StaticBackends</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-comment">
72
+ <div class="tsd-comment tsd-typography">
73
+ <div class="lead">
74
+ <p>A static backend sends traffic to a TCP address (hostname and port) that
75
+ is reachable on the public internet.</p>
76
+ </div>
77
+ </div>
78
+ </section>
79
+ <section class="tsd-panel tsd-hierarchy">
80
+ <h3>Hierarchy</h3>
81
+ <ul class="tsd-hierarchy">
82
+ <li>
83
+ <span class="target">StaticBackends</span>
84
+ </li>
85
+ </ul>
86
+ </section>
87
+ <section class="tsd-panel-group tsd-index-group">
88
+ <h2>Index</h2>
89
+ <section class="tsd-panel tsd-index-panel">
90
+ <div class="tsd-index-content">
91
+ <section class="tsd-index-section ">
92
+ <h3>Constructors</h3>
93
+ <ul class="tsd-index-list">
94
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="services.StaticBackends.html#constructor" class="tsd-kind-icon">constructor</a></li>
95
+ </ul>
96
+ </section>
97
+ <section class="tsd-index-section ">
98
+ <h3>Methods</h3>
99
+ <ul class="tsd-index-list">
100
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.StaticBackends.html#create" class="tsd-kind-icon">create</a></li>
101
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.StaticBackends.html#delete" class="tsd-kind-icon">delete</a></li>
102
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.StaticBackends.html#get" class="tsd-kind-icon">get</a></li>
103
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.StaticBackends.html#list" class="tsd-kind-icon">list</a></li>
104
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.StaticBackends.html#update" class="tsd-kind-icon">update</a></li>
105
+ </ul>
106
+ </section>
107
+ </div>
108
+ </section>
109
+ </section>
110
+ <section class="tsd-panel-group tsd-member-group ">
111
+ <h2>Constructors</h2>
112
+ <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
113
+ <a name="constructor" class="tsd-anchor"></a>
114
+ <h3>constructor</h3>
115
+ <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
116
+ <li class="tsd-signature tsd-kind-icon">new <wbr>Static<wbr>Backends<span class="tsd-signature-symbol">(</span>httpClient<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Wretcher</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="services.StaticBackends.html" class="tsd-signature-type" data-tsd-kind="Class">StaticBackends</a></li>
117
+ </ul>
118
+ <ul class="tsd-descriptions">
119
+ <li class="tsd-description">
120
+ <aside class="tsd-sources">
121
+ <ul>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L718">services.ts:718</a></li>
123
+ </ul>
124
+ </aside>
125
+ <div class="tsd-comment tsd-typography">
126
+ <div class="lead">
127
+ <p>Do not construct this object directly, use the <code>staticBackends</code> property of an <code>Ngrok</code> client object instead.</p>
128
+ </div>
129
+ </div>
130
+ <h4 class="tsd-parameters-title">Parameters</h4>
131
+ <ul class="tsd-parameters">
132
+ <li>
133
+ <h5>httpClient: <span class="tsd-signature-type">Wretcher</span></h5>
134
+ </li>
135
+ </ul>
136
+ <h4 class="tsd-returns-title">Returns <a href="services.StaticBackends.html" class="tsd-signature-type" data-tsd-kind="Class">StaticBackends</a></h4>
137
+ </li>
138
+ </ul>
139
+ </section>
140
+ </section>
141
+ <section class="tsd-panel-group tsd-member-group ">
142
+ <h2>Methods</h2>
143
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
144
+ <a name="create" class="tsd-anchor"></a>
145
+ <h3>create</h3>
146
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
147
+ <li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.StaticBackendCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackendCreate</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.StaticBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackend</a><span class="tsd-signature-symbol">&gt;</span></li>
148
+ </ul>
149
+ <ul class="tsd-descriptions">
150
+ <li class="tsd-description">
151
+ <aside class="tsd-sources">
152
+ <ul>
153
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L724">services.ts:724</a></li>
154
+ </ul>
155
+ </aside>
156
+ <div class="tsd-comment tsd-typography">
157
+ <div class="lead">
158
+ <p>Create a new static backend</p>
159
+ </div>
160
+ </div>
161
+ <h4 class="tsd-parameters-title">Parameters</h4>
162
+ <ul class="tsd-parameters">
163
+ <li>
164
+ <h5>arg: <a href="../interfaces/datatypes.StaticBackendCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackendCreate</a></h5>
165
+ </li>
166
+ </ul>
167
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.StaticBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackend</a><span class="tsd-signature-symbol">&gt;</span></h4>
168
+ </li>
169
+ </ul>
170
+ </section>
171
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
172
+ <a name="delete" class="tsd-anchor"></a>
173
+ <h3>delete</h3>
174
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
175
+ <li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
176
+ </ul>
177
+ <ul class="tsd-descriptions">
178
+ <li class="tsd-description">
179
+ <aside class="tsd-sources">
180
+ <ul>
181
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L736">services.ts:736</a></li>
182
+ </ul>
183
+ </aside>
184
+ <div class="tsd-comment tsd-typography">
185
+ <div class="lead">
186
+ <p>Delete a static backend by ID.</p>
187
+ </div>
188
+ </div>
189
+ <h4 class="tsd-parameters-title">Parameters</h4>
190
+ <ul class="tsd-parameters">
191
+ <li>
192
+ <h5>id: <span class="tsd-signature-type">any</span></h5>
193
+ </li>
194
+ </ul>
195
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
196
+ </li>
197
+ </ul>
198
+ </section>
199
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
200
+ <a name="get" class="tsd-anchor"></a>
201
+ <h3>get</h3>
202
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
203
+ <li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.StaticBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackend</a><span class="tsd-signature-symbol">&gt;</span></li>
204
+ </ul>
205
+ <ul class="tsd-descriptions">
206
+ <li class="tsd-description">
207
+ <aside class="tsd-sources">
208
+ <ul>
209
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L746">services.ts:746</a></li>
210
+ </ul>
211
+ </aside>
212
+ <div class="tsd-comment tsd-typography">
213
+ <div class="lead">
214
+ <p>Get detailed information about a static backend by ID</p>
215
+ </div>
216
+ </div>
217
+ <h4 class="tsd-parameters-title">Parameters</h4>
218
+ <ul class="tsd-parameters">
219
+ <li>
220
+ <h5>id: <span class="tsd-signature-type">any</span></h5>
221
+ </li>
222
+ </ul>
223
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.StaticBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackend</a><span class="tsd-signature-symbol">&gt;</span></h4>
224
+ </li>
225
+ </ul>
226
+ </section>
227
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
228
+ <a name="list" class="tsd-anchor"></a>
229
+ <h3>list</h3>
230
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
231
+ <li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span>beforeId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.StaticBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackend</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
232
+ </ul>
233
+ <ul class="tsd-descriptions">
234
+ <li class="tsd-description">
235
+ <aside class="tsd-sources">
236
+ <ul>
237
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L756">services.ts:756</a></li>
238
+ </ul>
239
+ </aside>
240
+ <div class="tsd-comment tsd-typography">
241
+ <div class="lead">
242
+ <p>List all static backends on this account</p>
243
+ </div>
244
+ </div>
245
+ <h4 class="tsd-parameters-title">Parameters</h4>
246
+ <ul class="tsd-parameters">
247
+ <li>
248
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> beforeId: <span class="tsd-signature-type">string</span></h5>
249
+ </li>
250
+ <li>
251
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">string</span></h5>
252
+ </li>
253
+ </ul>
254
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.StaticBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackend</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
255
+ </li>
256
+ </ul>
257
+ </section>
258
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
259
+ <a name="update" class="tsd-anchor"></a>
260
+ <h3>update</h3>
261
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
262
+ <li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.StaticBackendUpdate.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackendUpdate</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.StaticBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackend</a><span class="tsd-signature-symbol">&gt;</span></li>
263
+ </ul>
264
+ <ul class="tsd-descriptions">
265
+ <li class="tsd-description">
266
+ <aside class="tsd-sources">
267
+ <ul>
268
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L806">services.ts:806</a></li>
269
+ </ul>
270
+ </aside>
271
+ <div class="tsd-comment tsd-typography">
272
+ <div class="lead">
273
+ <p>Update static backend by ID</p>
274
+ </div>
275
+ </div>
276
+ <h4 class="tsd-parameters-title">Parameters</h4>
277
+ <ul class="tsd-parameters">
278
+ <li>
279
+ <h5>arg: <a href="../interfaces/datatypes.StaticBackendUpdate.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackendUpdate</a></h5>
280
+ </li>
281
+ </ul>
282
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.StaticBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackend</a><span class="tsd-signature-symbol">&gt;</span></h4>
283
+ </li>
284
+ </ul>
285
+ </section>
286
+ </section>
287
+ </div>
288
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
289
+ <nav class="tsd-navigation primary">
290
+ <ul>
291
+ <li class=" ">
292
+ <a href="../modules.html">Modules</a>
293
+ </li>
294
+ <li class=" tsd-kind-module">
295
+ <a href="../modules/client.html">client</a>
296
+ </li>
297
+ <li class=" tsd-kind-module">
298
+ <a href="../modules/datatypes.html">datatypes</a>
299
+ </li>
300
+ <li class="current tsd-kind-module">
301
+ <a href="../modules/services.html">services</a>
302
+ </li>
303
+ </ul>
304
+ </nav>
305
+ <nav class="tsd-navigation secondary menu-sticky">
306
+ <ul class="before-current">
307
+ </ul>
308
+ <ul class="current">
309
+ <li class="current tsd-kind-class tsd-parent-kind-module">
310
+ <a href="services.StaticBackends.html" class="tsd-kind-icon">Static<wbr>Backends</a>
311
+ <ul>
312
+ <li class=" tsd-kind-constructor tsd-parent-kind-class">
313
+ <a href="services.StaticBackends.html#constructor" class="tsd-kind-icon">constructor</a>
314
+ </li>
315
+ <li class=" tsd-kind-method tsd-parent-kind-class">
316
+ <a href="services.StaticBackends.html#create" class="tsd-kind-icon">create</a>
317
+ </li>
318
+ <li class=" tsd-kind-method tsd-parent-kind-class">
319
+ <a href="services.StaticBackends.html#delete" class="tsd-kind-icon">delete</a>
320
+ </li>
321
+ <li class=" tsd-kind-method tsd-parent-kind-class">
322
+ <a href="services.StaticBackends.html#get" class="tsd-kind-icon">get</a>
323
+ </li>
324
+ <li class=" tsd-kind-method tsd-parent-kind-class">
325
+ <a href="services.StaticBackends.html#list" class="tsd-kind-icon">list</a>
326
+ </li>
327
+ <li class=" tsd-kind-method tsd-parent-kind-class">
328
+ <a href="services.StaticBackends.html#update" class="tsd-kind-icon">update</a>
329
+ </li>
330
+ </ul>
331
+ </li>
332
+ </ul>
333
+ <ul class="after-current">
334
+ </ul>
335
+ </nav>
336
+ </div>
337
+ </div>
338
+ </div>
339
+ <footer class="with-border-bottom">
340
+ <div class="container">
341
+ <h2>Legend</h2>
342
+ <div class="tsd-legend-group">
343
+ <ul class="tsd-legend">
344
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
345
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
346
+ <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
347
+ </ul>
348
+ <ul class="tsd-legend">
349
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
350
+ </ul>
351
+ </div>
352
+ </div>
353
+ </footer>
354
+ <div class="container tsd-generator">
355
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
356
+ </div>
357
+ <div class="overlay"></div>
358
+ <script src="../assets/js/main.js"></script>
359
+ </body>
360
+ </html>
@@ -109,7 +109,7 @@
109
109
  <li class="tsd-description">
110
110
  <aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L1546">services.ts:1546</a></li>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L2101">services.ts:2101</a></li>
113
113
  </ul>
114
114
  </aside>
115
115
  <div class="tsd-comment tsd-typography">
@@ -134,19 +134,19 @@
134
134
  <a name="delete" class="tsd-anchor"></a>
135
135
  <h3>delete</h3>
136
136
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
137
- <li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
137
+ <li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
138
138
  </ul>
139
139
  <ul class="tsd-descriptions">
140
140
  <li class="tsd-description">
141
141
  <aside class="tsd-sources">
142
142
  <ul>
143
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L1567">services.ts:1567</a></li>
143
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L2120">services.ts:2120</a></li>
144
144
  </ul>
145
145
  </aside>
146
146
  <h4 class="tsd-parameters-title">Parameters</h4>
147
147
  <ul class="tsd-parameters">
148
148
  <li>
149
- <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
149
+ <h5>id: <span class="tsd-signature-type">any</span></h5>
150
150
  </li>
151
151
  </ul>
152
152
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -157,19 +157,19 @@
157
157
  <a name="get" class="tsd-anchor"></a>
158
158
  <h3>get</h3>
159
159
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
160
- <li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.EndpointBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a><span class="tsd-signature-symbol">&gt;</span></li>
160
+ <li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.EndpointBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a><span class="tsd-signature-symbol">&gt;</span></li>
161
161
  </ul>
162
162
  <ul class="tsd-descriptions">
163
163
  <li class="tsd-description">
164
164
  <aside class="tsd-sources">
165
165
  <ul>
166
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L1559">services.ts:1559</a></li>
166
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L2113">services.ts:2113</a></li>
167
167
  </ul>
168
168
  </aside>
169
169
  <h4 class="tsd-parameters-title">Parameters</h4>
170
170
  <ul class="tsd-parameters">
171
171
  <li>
172
- <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
172
+ <h5>id: <span class="tsd-signature-type">any</span></h5>
173
173
  </li>
174
174
  </ul>
175
175
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.EndpointBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -186,7 +186,7 @@
186
186
  <li class="tsd-description">
187
187
  <aside class="tsd-sources">
188
188
  <ul>
189
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L1549">services.ts:1549</a></li>
189
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L2104">services.ts:2104</a></li>
190
190
  </ul>
191
191
  </aside>
192
192
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -109,7 +109,7 @@
109
109
  <li class="tsd-description">
110
110
  <aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L1580">services.ts:1580</a></li>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L2133">services.ts:2133</a></li>
113
113
  </ul>
114
114
  </aside>
115
115
  <div class="tsd-comment tsd-typography">
@@ -134,19 +134,19 @@
134
134
  <a name="delete" class="tsd-anchor"></a>
135
135
  <h3>delete</h3>
136
136
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
137
- <li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
137
+ <li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
138
138
  </ul>
139
139
  <ul class="tsd-descriptions">
140
140
  <li class="tsd-description">
141
141
  <aside class="tsd-sources">
142
142
  <ul>
143
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L1601">services.ts:1601</a></li>
143
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L2152">services.ts:2152</a></li>
144
144
  </ul>
145
145
  </aside>
146
146
  <h4 class="tsd-parameters-title">Parameters</h4>
147
147
  <ul class="tsd-parameters">
148
148
  <li>
149
- <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
149
+ <h5>id: <span class="tsd-signature-type">any</span></h5>
150
150
  </li>
151
151
  </ul>
152
152
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -157,19 +157,19 @@
157
157
  <a name="get" class="tsd-anchor"></a>
158
158
  <h3>get</h3>
159
159
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
160
- <li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a><span class="tsd-signature-symbol">&gt;</span></li>
160
+ <li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a><span class="tsd-signature-symbol">&gt;</span></li>
161
161
  </ul>
162
162
  <ul class="tsd-descriptions">
163
163
  <li class="tsd-description">
164
164
  <aside class="tsd-sources">
165
165
  <ul>
166
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L1593">services.ts:1593</a></li>
166
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L2145">services.ts:2145</a></li>
167
167
  </ul>
168
168
  </aside>
169
169
  <h4 class="tsd-parameters-title">Parameters</h4>
170
170
  <ul class="tsd-parameters">
171
171
  <li>
172
- <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
172
+ <h5>id: <span class="tsd-signature-type">any</span></h5>
173
173
  </li>
174
174
  </ul>
175
175
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -186,7 +186,7 @@
186
186
  <li class="tsd-description">
187
187
  <aside class="tsd-sources">
188
188
  <ul>
189
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L1583">services.ts:1583</a></li>
189
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L2136">services.ts:2136</a></li>
190
190
  </ul>
191
191
  </aside>
192
192
  <h4 class="tsd-parameters-title">Parameters</h4>