@ngrok/ngrok-api 0.1.0 → 0.7.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 (283) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +102 -31
  3. package/docs/CNAME +1 -0
  4. package/docs/assets/js/search.js +1 -1
  5. package/docs/classes/client.Ngrok.html +772 -0
  6. package/docs/classes/services.APIKeys.html +354 -0
  7. package/docs/classes/services.AbuseReports.html +261 -0
  8. package/docs/classes/services.AgentIngresses.html +343 -0
  9. package/docs/classes/services.CertificateAuthorities.html +354 -0
  10. package/docs/classes/services.Credentials.html +353 -0
  11. package/docs/classes/services.EdgeRouteBackendModule.html +270 -0
  12. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +270 -0
  13. package/docs/classes/services.EdgeRouteCompressionModule.html +270 -0
  14. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +270 -0
  15. package/docs/classes/services.EdgeRouteOAuthModule.html +270 -0
  16. package/docs/classes/services.EdgeRouteOIDCModule.html +270 -0
  17. package/docs/classes/services.EdgeRouteRequestHeadersModule.html +270 -0
  18. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +270 -0
  19. package/docs/classes/services.EdgeRouteSAMLModule.html +270 -0
  20. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +270 -0
  21. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +270 -0
  22. package/docs/classes/services.EdgesHTTPS.html +343 -0
  23. package/docs/classes/services.EdgesHTTPSRoutes.html +317 -0
  24. package/docs/classes/services.EdgesTCP.html +343 -0
  25. package/docs/classes/services.EdgesTLS.html +343 -0
  26. package/docs/classes/services.Endpoints.html +256 -0
  27. package/docs/classes/services.EventDestinations.html +343 -0
  28. package/docs/classes/services.EventSources.html +349 -0
  29. package/docs/classes/services.EventSubscriptions.html +343 -0
  30. package/docs/classes/services.FailoverBackends.html +353 -0
  31. package/docs/classes/services.HTTPResponseBackends.html +318 -0
  32. package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +270 -0
  33. package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +270 -0
  34. package/docs/classes/services.IPPolicies.html +353 -0
  35. package/docs/classes/services.IPPolicyRules.html +351 -0
  36. package/docs/classes/services.IPRestrictions.html +355 -0
  37. package/docs/classes/services.ReservedAddrs.html +352 -0
  38. package/docs/classes/services.ReservedDomains.html +417 -0
  39. package/docs/classes/services.SSHCertificateAuthorities.html +351 -0
  40. package/docs/classes/services.SSHCredentials.html +351 -0
  41. package/docs/classes/services.SSHHostCertificates.html +352 -0
  42. package/docs/classes/services.SSHUserCertificates.html +352 -0
  43. package/docs/classes/services.TCPEdgeBackendModule.html +270 -0
  44. package/docs/classes/services.TCPEdgeIPRestrictionModule.html +270 -0
  45. package/docs/classes/services.TLSCertificates.html +354 -0
  46. package/docs/classes/services.TLSEdgeBackendModule.html +270 -0
  47. package/docs/classes/services.TLSEdgeIPRestrictionModule.html +270 -0
  48. package/docs/classes/services.TLSEdgeMutualTLSModule.html +270 -0
  49. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +270 -0
  50. package/docs/classes/services.TunnelGroupBackends.html +351 -0
  51. package/docs/classes/services.TunnelSessions.html +352 -0
  52. package/docs/classes/services.Tunnels.html +255 -0
  53. package/docs/classes/services.WeightedBackends.html +353 -0
  54. package/docs/index.html +103 -546
  55. package/docs/interfaces/client.NgrokConfig.html +179 -0
  56. package/docs/interfaces/{apikey.html → datatypes.APIKey.html} +41 -29
  57. package/docs/interfaces/{apikeycreate.html → datatypes.APIKeyCreate.html} +25 -13
  58. package/docs/interfaces/{apikeylist.html → datatypes.APIKeyList.html} +32 -20
  59. package/docs/interfaces/{apikeyupdate.html → datatypes.APIKeyUpdate.html} +28 -16
  60. package/docs/interfaces/{awsauth.html → datatypes.AWSAuth.html} +27 -15
  61. package/docs/interfaces/{awscredentials.html → datatypes.AWSCredentials.html} +31 -19
  62. package/docs/interfaces/{awsrole.html → datatypes.AWSRole.html} +25 -13
  63. package/docs/interfaces/{abusereport.html → datatypes.AbuseReport.html} +45 -33
  64. package/docs/interfaces/{abusereportcreate.html → datatypes.AbuseReportCreate.html} +25 -13
  65. package/docs/interfaces/{abusereporthostname.html → datatypes.AbuseReportHostname.html} +26 -14
  66. package/docs/interfaces/datatypes.AgentIngress.html +300 -0
  67. package/docs/interfaces/{ipwhitelistentrycreate.html → datatypes.AgentIngressCreate.html} +37 -25
  68. package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
  69. package/docs/interfaces/{ipwhitelistentryupdate.html → datatypes.AgentIngressUpdate.html} +33 -21
  70. package/docs/interfaces/{certificateauthority.html → datatypes.CertificateAuthority.html} +73 -61
  71. package/docs/interfaces/{certificateauthoritycreate.html → datatypes.CertificateAuthorityCreate.html} +31 -19
  72. package/docs/interfaces/{certificateauthoritylist.html → datatypes.CertificateAuthorityList.html} +34 -22
  73. package/docs/interfaces/{certificateauthorityupdate.html → datatypes.CertificateAuthorityUpdate.html} +28 -16
  74. package/docs/interfaces/{credential.html → datatypes.Credential.html} +45 -33
  75. package/docs/interfaces/{credentialcreate.html → datatypes.CredentialCreate.html} +29 -17
  76. package/docs/interfaces/{credentiallist.html → datatypes.CredentialList.html} +32 -20
  77. package/docs/interfaces/{credentialupdate.html → datatypes.CredentialUpdate.html} +32 -20
  78. package/docs/interfaces/{endpointippolicyreplace.html → datatypes.EdgeBackendReplace.html} +29 -17
  79. package/docs/interfaces/{endpointbackendreplace.html → datatypes.EdgeIPRestrictionReplace.html} +29 -17
  80. package/docs/interfaces/{endpointresponseheadersreplace.html → datatypes.EdgeMutualTLSReplace.html} +29 -17
  81. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +190 -0
  82. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +190 -0
  83. package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +190 -0
  84. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +190 -0
  85. package/docs/interfaces/{reserveddomaincertnstarget.html → datatypes.EdgeRouteItem.html} +36 -24
  86. package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +190 -0
  87. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +190 -0
  88. package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +190 -0
  89. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +190 -0
  90. package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +190 -0
  91. package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +190 -0
  92. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +190 -0
  93. package/docs/interfaces/{endpointoauthreplace.html → datatypes.EdgeTLSTerminationAtEdgeReplace.html} +29 -17
  94. package/docs/interfaces/{endpointbasicauthreplace.html → datatypes.EdgeTLSTerminationReplace.html} +29 -17
  95. package/docs/interfaces/{empty.html → datatypes.Empty.html} +18 -7
  96. package/docs/interfaces/datatypes.Endpoint.html +395 -0
  97. package/docs/interfaces/{endpointbackend.html → datatypes.EndpointBackend.html} +27 -15
  98. package/docs/interfaces/{endpointlogging.html → datatypes.EndpointBackendMutate.html} +36 -24
  99. package/docs/interfaces/{endpointcircuitbreaker.html → datatypes.EndpointCircuitBreaker.html} +53 -41
  100. package/docs/interfaces/{endpointcompression.html → datatypes.EndpointCompression.html} +23 -11
  101. package/docs/interfaces/{endpointippolicy.html → datatypes.EndpointIPPolicy.html} +29 -17
  102. package/docs/interfaces/{endpointippolicymutate.html → datatypes.EndpointIPPolicyMutate.html} +29 -17
  103. package/docs/interfaces/datatypes.EndpointList.html +205 -0
  104. package/docs/interfaces/{endpointmutualtls.html → datatypes.EndpointMutualTLS.html} +29 -17
  105. package/docs/interfaces/{endpointmutualtlsmutate.html → datatypes.EndpointMutualTLSMutate.html} +29 -17
  106. package/docs/interfaces/{endpointoauth.html → datatypes.EndpointOAuth.html} +57 -45
  107. package/docs/interfaces/{endpointoauthfacebook.html → datatypes.EndpointOAuthFacebook.html} +48 -36
  108. package/docs/interfaces/{endpointoauthgithub.html → datatypes.EndpointOAuthGitHub.html} +55 -43
  109. package/docs/interfaces/{endpointoauthgoogle.html → datatypes.EndpointOAuthGoogle.html} +48 -36
  110. package/docs/interfaces/{endpointoauthmicrosoft.html → datatypes.EndpointOAuthMicrosoft.html} +48 -36
  111. package/docs/interfaces/{endpointoauthprovider.html → datatypes.EndpointOAuthProvider.html} +35 -23
  112. package/docs/interfaces/{endpointoidc.html → datatypes.EndpointOIDC.html} +65 -53
  113. package/docs/interfaces/{endpointrequestheaders.html → datatypes.EndpointRequestHeaders.html} +29 -17
  114. package/docs/interfaces/{endpointresponseheaders.html → datatypes.EndpointResponseHeaders.html} +29 -17
  115. package/docs/interfaces/{endpointsaml.html → datatypes.EndpointSAML.html} +121 -90
  116. package/docs/interfaces/{endpointsamlmutate.html → datatypes.EndpointSAMLMutate.html} +91 -60
  117. package/docs/interfaces/{endpointtlstermination.html → datatypes.EndpointTLSTermination.html} +37 -25
  118. package/docs/interfaces/{endpointloggingmutate.html → datatypes.EndpointTLSTerminationAtEdge.html} +33 -21
  119. package/docs/interfaces/{endpointwebhookvalidation.html → datatypes.EndpointWebhookValidation.html} +30 -18
  120. package/docs/interfaces/{staticbackendtls.html → datatypes.EndpointWebsocketTCPConverter.html} +27 -15
  121. package/docs/interfaces/{error.html → datatypes.Error.html} +37 -25
  122. package/docs/interfaces/{eventdestination.html → datatypes.EventDestination.html} +46 -34
  123. package/docs/interfaces/{eventdestinationcreate.html → datatypes.EventDestinationCreate.html} +34 -22
  124. package/docs/interfaces/{eventdestinationlist.html → datatypes.EventDestinationList.html} +34 -22
  125. package/docs/interfaces/{eventdestinationupdate.html → datatypes.EventDestinationUpdate.html} +37 -25
  126. package/docs/interfaces/{eventsource.html → datatypes.EventSource.html} +25 -13
  127. package/docs/interfaces/{eventsourcecreate.html → datatypes.EventSourceCreate.html} +28 -16
  128. package/docs/interfaces/{eventsourceitem.html → datatypes.EventSourceItem.html} +28 -16
  129. package/docs/interfaces/{eventsourcelist.html → datatypes.EventSourceList.html} +26 -14
  130. package/docs/interfaces/{eventsourcepaging.html → datatypes.EventSourcePaging.html} +25 -13
  131. package/docs/interfaces/{eventsourcereplace.html → datatypes.EventSourceReplace.html} +22 -10
  132. package/docs/interfaces/{eventsourceupdate.html → datatypes.EventSourceUpdate.html} +28 -16
  133. package/docs/interfaces/{eventsubscription.html → datatypes.EventSubscription.html} +45 -33
  134. package/docs/interfaces/{eventsubscriptioncreate.html → datatypes.EventSubscriptionCreate.html} +36 -24
  135. package/docs/interfaces/{eventsubscriptionlist.html → datatypes.EventSubscriptionList.html} +34 -22
  136. package/docs/interfaces/{eventsubscriptionupdate.html → datatypes.EventSubscriptionUpdate.html} +39 -27
  137. package/docs/interfaces/{eventtarget.html → datatypes.EventTarget.html} +33 -21
  138. package/docs/interfaces/{eventtargetcloudwatchlogs.html → datatypes.EventTargetCloudwatchLogs.html} +30 -18
  139. package/docs/interfaces/{eventtargetfirehose.html → datatypes.EventTargetFirehose.html} +30 -18
  140. package/docs/interfaces/{eventtargetkinesis.html → datatypes.EventTargetKinesis.html} +30 -18
  141. package/docs/interfaces/{staticbackend.html → datatypes.FailoverBackend.html} +52 -40
  142. package/docs/interfaces/{prioritybackendcreate.html → datatypes.FailoverBackendCreate.html} +31 -19
  143. package/docs/interfaces/{prioritybackendlist.html → datatypes.FailoverBackendList.html} +37 -25
  144. package/docs/interfaces/{prioritybackendupdate.html → datatypes.FailoverBackendUpdate.html} +34 -22
  145. package/docs/interfaces/datatypes.HTTPResponseBackend.html +295 -0
  146. package/docs/interfaces/{tunnelgroupbackend.html → datatypes.HTTPResponseBackendCreate.html} +53 -41
  147. package/docs/interfaces/{staticbackendlist.html → datatypes.HTTPResponseBackendList.html} +35 -38
  148. package/docs/interfaces/{tcpedge.html → datatypes.HTTPResponseBackendUpdate.html} +58 -65
  149. package/docs/interfaces/{eventstream.html → datatypes.HTTPSEdge.html} +78 -71
  150. package/docs/interfaces/{staticbackendupdate.html → datatypes.HTTPSEdgeCreate.html} +60 -48
  151. package/docs/interfaces/datatypes.HTTPSEdgeList.html +205 -0
  152. package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +509 -0
  153. package/docs/interfaces/{endpointconfigurationcreate.html → datatypes.HTTPSEdgeRouteCreate.html} +141 -110
  154. package/docs/interfaces/{endpointconfiguration.html → datatypes.HTTPSEdgeRouteUpdate.html} +138 -145
  155. package/docs/interfaces/{tlsedgeupdate.html → datatypes.HTTPSEdgeUpdate.html} +65 -43
  156. package/docs/interfaces/{ippolicy.html → datatypes.IPPolicy.html} +37 -44
  157. package/docs/interfaces/{ippolicycreate.html → datatypes.IPPolicyCreate.html} +25 -32
  158. package/docs/interfaces/{ippolicylist.html → datatypes.IPPolicyList.html} +34 -22
  159. package/docs/interfaces/{ippolicyrule.html → datatypes.IPPolicyRule.html} +65 -34
  160. package/docs/interfaces/{ippolicyrulecreate.html → datatypes.IPPolicyRuleCreate.html} +53 -22
  161. package/docs/interfaces/{ippolicyrulelist.html → datatypes.IPPolicyRuleList.html} +34 -22
  162. package/docs/interfaces/{ippolicyruleupdate.html → datatypes.IPPolicyRuleUpdate.html} +31 -19
  163. package/docs/interfaces/{ippolicyupdate.html → datatypes.IPPolicyUpdate.html} +28 -16
  164. package/docs/interfaces/{iprestriction.html → datatypes.IPRestriction.html} +50 -38
  165. package/docs/interfaces/{iprestrictioncreate.html → datatypes.IPRestrictionCreate.html} +38 -26
  166. package/docs/interfaces/{iprestrictionlist.html → datatypes.IPRestrictionList.html} +34 -22
  167. package/docs/interfaces/{iprestrictionupdate.html → datatypes.IPRestrictionUpdate.html} +37 -25
  168. package/docs/interfaces/{item.html → datatypes.Item.html} +22 -10
  169. package/docs/interfaces/{paging.html → datatypes.Paging.html} +28 -16
  170. package/docs/interfaces/{ref.html → datatypes.Ref.html} +25 -13
  171. package/docs/interfaces/{reservedaddr.html → datatypes.ReservedAddr.html} +43 -50
  172. package/docs/interfaces/{reservedaddrcreate.html → datatypes.ReservedAddrCreate.html} +28 -35
  173. package/docs/interfaces/{reservedaddrlist.html → datatypes.ReservedAddrList.html} +34 -22
  174. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +200 -0
  175. package/docs/interfaces/{reserveddomain.html → datatypes.ReservedDomain.html} +82 -89
  176. package/docs/interfaces/{reserveddomaincertjob.html → datatypes.ReservedDomainCertJob.html} +40 -47
  177. package/docs/interfaces/{reserveddomaincertpolicy.html → datatypes.ReservedDomainCertPolicy.html} +28 -16
  178. package/docs/interfaces/{reserveddomaincertstatus.html → datatypes.ReservedDomainCertStatus.html} +31 -19
  179. package/docs/interfaces/{reserveddomaincreate.html → datatypes.ReservedDomainCreate.html} +45 -71
  180. package/docs/interfaces/{reserveddomainlist.html → datatypes.ReservedDomainList.html} +34 -22
  181. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +238 -0
  182. package/docs/interfaces/{sshcertificateauthority.html → datatypes.SSHCertificateAuthority.html} +49 -37
  183. package/docs/interfaces/{sshcertificateauthoritycreate.html → datatypes.SSHCertificateAuthorityCreate.html} +45 -33
  184. package/docs/interfaces/{sshcertificateauthoritylist.html → datatypes.SSHCertificateAuthorityList.html} +34 -22
  185. package/docs/interfaces/{sshcertificateauthorityupdate.html → datatypes.SSHCertificateAuthorityUpdate.html} +28 -16
  186. package/docs/interfaces/{sshcredential.html → datatypes.SSHCredential.html} +47 -35
  187. package/docs/interfaces/{sshcredentialcreate.html → datatypes.SSHCredentialCreate.html} +35 -23
  188. package/docs/interfaces/{sshcredentiallist.html → datatypes.SSHCredentialList.html} +34 -22
  189. package/docs/interfaces/{sshcredentialupdate.html → datatypes.SSHCredentialUpdate.html} +32 -20
  190. package/docs/interfaces/{sshhostcertificate.html → datatypes.SSHHostCertificate.html} +76 -64
  191. package/docs/interfaces/{sshhostcertificatecreate.html → datatypes.SSHHostCertificateCreate.html} +53 -41
  192. package/docs/interfaces/{sshhostcertificatelist.html → datatypes.SSHHostCertificateList.html} +34 -22
  193. package/docs/interfaces/{sshhostcertificateupdate.html → datatypes.SSHHostCertificateUpdate.html} +28 -16
  194. package/docs/interfaces/{sshusercertificate.html → datatypes.SSHUserCertificate.html} +87 -75
  195. package/docs/interfaces/{sshusercertificatecreate.html → datatypes.SSHUserCertificateCreate.html} +64 -52
  196. package/docs/interfaces/{sshusercertificatelist.html → datatypes.SSHUserCertificateList.html} +34 -22
  197. package/docs/interfaces/{sshusercertificateupdate.html → datatypes.SSHUserCertificateUpdate.html} +28 -16
  198. package/docs/interfaces/{tlsedge.html → datatypes.TCPEdge.html} +69 -66
  199. package/docs/interfaces/{tlsedgecreate.html → datatypes.TCPEdgeCreate.html} +64 -42
  200. package/docs/interfaces/{endpointconfigurationlist.html → datatypes.TCPEdgeList.html} +40 -28
  201. package/docs/interfaces/{eventstreamupdate.html → datatypes.TCPEdgeUpdate.html} +60 -53
  202. package/docs/interfaces/{tlscertificate.html → datatypes.TLSCertificate.html} +134 -122
  203. package/docs/interfaces/{tlscertificatecreate.html → datatypes.TLSCertificateCreate.html} +39 -27
  204. package/docs/interfaces/{tlscertificatelist.html → datatypes.TLSCertificateList.html} +34 -22
  205. package/docs/interfaces/{tlscertificatesans.html → datatypes.TLSCertificateSANs.html} +28 -16
  206. package/docs/interfaces/{tlscertificateupdate.html → datatypes.TLSCertificateUpdate.html} +28 -16
  207. package/docs/interfaces/datatypes.TLSEdge.html +323 -0
  208. package/docs/interfaces/datatypes.TLSEdgeCreate.html +266 -0
  209. package/docs/interfaces/datatypes.TLSEdgeList.html +205 -0
  210. package/docs/interfaces/{reserveddomainupdate.html → datatypes.TLSEdgeUpdate.html} +83 -62
  211. package/docs/interfaces/datatypes.Tunnel.html +357 -0
  212. package/docs/interfaces/datatypes.TunnelGroupBackend.html +281 -0
  213. package/docs/interfaces/{tunnelgroupbackendcreate.html → datatypes.TunnelGroupBackendCreate.html} +28 -16
  214. package/docs/interfaces/{tunnelgroupbackendlist.html → datatypes.TunnelGroupBackendList.html} +32 -20
  215. package/docs/interfaces/{tunnelgroupbackendupdate.html → datatypes.TunnelGroupBackendUpdate.html} +31 -19
  216. package/docs/interfaces/{tunnellist.html → datatypes.TunnelList.html} +32 -20
  217. package/docs/interfaces/{tunnelsession.html → datatypes.TunnelSession.html} +57 -45
  218. package/docs/interfaces/{tunnelsessionlist.html → datatypes.TunnelSessionList.html} +34 -22
  219. package/docs/interfaces/{tunnelsessionsupdate.html → datatypes.TunnelSessionsUpdate.html} +22 -10
  220. package/docs/interfaces/{weightedbackend.html → datatypes.WeightedBackend.html} +56 -25
  221. package/docs/interfaces/{weightedbackendcreate.html → datatypes.WeightedBackendCreate.html} +28 -16
  222. package/docs/interfaces/{weightedbackendlist.html → datatypes.WeightedBackendList.html} +32 -20
  223. package/docs/interfaces/{weightedbackendupdate.html → datatypes.WeightedBackendUpdate.html} +31 -19
  224. package/docs/{interfaces/endpointbasicauth.html → modules/client.html} +38 -20
  225. package/docs/modules/datatypes.html +796 -0
  226. package/docs/modules/services.html +316 -0
  227. package/docs/modules.html +16 -690
  228. package/lib/client.d.ts +179 -0
  229. package/lib/client.d.ts.map +1 -0
  230. package/lib/client.js +126 -0
  231. package/lib/client.js.map +1 -0
  232. package/lib/{types.d.ts → datatypes.d.ts} +729 -660
  233. package/lib/datatypes.d.ts.map +1 -0
  234. package/lib/{types.js → datatypes.js} +1 -1
  235. package/lib/datatypes.js.map +1 -0
  236. package/lib/index.d.ts +2 -378
  237. package/lib/index.d.ts.map +1 -1
  238. package/lib/index.js +2 -2148
  239. package/lib/index.js.map +1 -1
  240. package/lib/services.d.ts +993 -0
  241. package/lib/services.d.ts.map +1 -0
  242. package/lib/services.js +3600 -0
  243. package/lib/services.js.map +1 -0
  244. package/lib/util.d.ts +5 -0
  245. package/lib/util.d.ts.map +1 -0
  246. package/lib/util.js +53 -0
  247. package/lib/util.js.map +1 -0
  248. package/package.json +2 -2
  249. package/src/client.ts +322 -0
  250. package/src/{types.ts → datatypes.ts} +760 -689
  251. package/src/index.ts +2 -1775
  252. package/src/services.ts +3380 -0
  253. package/src/util.ts +48 -0
  254. package/test/apikey.test.js +41 -30
  255. package/docs/classes/ngrok.html +0 -5028
  256. package/docs/interfaces/endpointbackendmutate.html +0 -119
  257. package/docs/interfaces/endpointcircuitbreakerreplace.html +0 -164
  258. package/docs/interfaces/endpointcompressionreplace.html +0 -164
  259. package/docs/interfaces/endpointconfigurationupdate.html +0 -421
  260. package/docs/interfaces/endpointloggingreplace.html +0 -164
  261. package/docs/interfaces/endpointmutualtlsreplace.html +0 -164
  262. package/docs/interfaces/endpointoidcreplace.html +0 -164
  263. package/docs/interfaces/endpointrequestheadersreplace.html +0 -164
  264. package/docs/interfaces/endpointsamlreplace.html +0 -164
  265. package/docs/interfaces/endpointtlsterminationreplace.html +0 -164
  266. package/docs/interfaces/endpointwebhookvalidationreplace.html +0 -164
  267. package/docs/interfaces/eventstreamcreate.html +0 -250
  268. package/docs/interfaces/eventstreamlist.html +0 -193
  269. package/docs/interfaces/eventtargetdebug.html +0 -119
  270. package/docs/interfaces/eventtargets3.html +0 -250
  271. package/docs/interfaces/ipwhitelistentry.html +0 -250
  272. package/docs/interfaces/ipwhitelistentrylist.html +0 -193
  273. package/docs/interfaces/prioritybackend.html +0 -231
  274. package/docs/interfaces/reservedaddrupdate.html +0 -207
  275. package/docs/interfaces/rootresponse.html +0 -164
  276. package/docs/interfaces/sentevent.html +0 -150
  277. package/docs/interfaces/staticbackendcreate.html +0 -212
  278. package/docs/interfaces/tcpedgecreate.html +0 -188
  279. package/docs/interfaces/tcpedgeupdate.html +0 -207
  280. package/docs/interfaces/tunnel.html +0 -269
  281. package/lib/types.d.ts.map +0 -1
  282. package/lib/types.js.map +0 -1
  283. package/test/endpointConfigurations.test.js +0 -63
package/docs/classes/services.TunnelSessions.html ADDED
@@ -0,0 +1,352 @@
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>TunnelSessions | @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.TunnelSessions.html">TunnelSessions</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Class TunnelSessions</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>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
75
+ sessions that are running and connected to the ngrok service. Each tunnel
76
+ session can include one or more Tunnels.</p>
77
+ </div>
78
+ </div>
79
+ </section>
80
+ <section class="tsd-panel tsd-hierarchy">
81
+ <h3>Hierarchy</h3>
82
+ <ul class="tsd-hierarchy">
83
+ <li>
84
+ <span class="target">TunnelSessions</span>
85
+ </li>
86
+ </ul>
87
+ </section>
88
+ <section class="tsd-panel-group tsd-index-group">
89
+ <h2>Index</h2>
90
+ <section class="tsd-panel tsd-index-panel">
91
+ <div class="tsd-index-content">
92
+ <section class="tsd-index-section ">
93
+ <h3>Constructors</h3>
94
+ <ul class="tsd-index-list">
95
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="services.TunnelSessions.html#constructor" class="tsd-kind-icon">constructor</a></li>
96
+ </ul>
97
+ </section>
98
+ <section class="tsd-index-section ">
99
+ <h3>Methods</h3>
100
+ <ul class="tsd-index-list">
101
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TunnelSessions.html#get" class="tsd-kind-icon">get</a></li>
102
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TunnelSessions.html#list" class="tsd-kind-icon">list</a></li>
103
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TunnelSessions.html#restart" class="tsd-kind-icon">restart</a></li>
104
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TunnelSessions.html#stop" class="tsd-kind-icon">stop</a></li>
105
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TunnelSessions.html#update" class="tsd-kind-icon">update</a></li>
106
+ </ul>
107
+ </section>
108
+ </div>
109
+ </section>
110
+ </section>
111
+ <section class="tsd-panel-group tsd-member-group ">
112
+ <h2>Constructors</h2>
113
+ <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
114
+ <a name="constructor" class="tsd-anchor"></a>
115
+ <h3>constructor</h3>
116
+ <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
117
+ <li class="tsd-signature tsd-kind-icon">new <wbr>Tunnel<wbr>Sessions<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.TunnelSessions.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelSessions</a></li>
118
+ </ul>
119
+ <ul class="tsd-descriptions">
120
+ <li class="tsd-description">
121
+ <aside class="tsd-sources">
122
+ <ul>
123
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3229">services.ts:3229</a></li>
124
+ </ul>
125
+ </aside>
126
+ <div class="tsd-comment tsd-typography">
127
+ <div class="lead">
128
+ <p>Do not construct this object directly, use the <code>tunnelSessions</code> property of an <code>Ngrok</code> client object instead.</p>
129
+ </div>
130
+ </div>
131
+ <h4 class="tsd-parameters-title">Parameters</h4>
132
+ <ul class="tsd-parameters">
133
+ <li>
134
+ <h5>httpClient: <span class="tsd-signature-type">Wretcher</span></h5>
135
+ </li>
136
+ </ul>
137
+ <h4 class="tsd-returns-title">Returns <a href="services.TunnelSessions.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelSessions</a></h4>
138
+ </li>
139
+ </ul>
140
+ </section>
141
+ </section>
142
+ <section class="tsd-panel-group tsd-member-group ">
143
+ <h2>Methods</h2>
144
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
145
+ <a name="get" class="tsd-anchor"></a>
146
+ <h3>get</h3>
147
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
148
+ <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.TunnelSession.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSession</a><span class="tsd-signature-symbol">&gt;</span></li>
149
+ </ul>
150
+ <ul class="tsd-descriptions">
151
+ <li class="tsd-description">
152
+ <aside class="tsd-sources">
153
+ <ul>
154
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3277">services.ts:3277</a></li>
155
+ </ul>
156
+ </aside>
157
+ <div class="tsd-comment tsd-typography">
158
+ <div class="lead">
159
+ <p>Get the detailed status of a tunnel session by ID</p>
160
+ </div>
161
+ </div>
162
+ <h4 class="tsd-parameters-title">Parameters</h4>
163
+ <ul class="tsd-parameters">
164
+ <li>
165
+ <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
166
+ </li>
167
+ </ul>
168
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.TunnelSession.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSession</a><span class="tsd-signature-symbol">&gt;</span></h4>
169
+ </li>
170
+ </ul>
171
+ </section>
172
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
173
+ <a name="list" class="tsd-anchor"></a>
174
+ <h3>list</h3>
175
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
176
+ <li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</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.TunnelSession.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSession</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
177
+ </ul>
178
+ <ul class="tsd-descriptions">
179
+ <li class="tsd-description">
180
+ <aside class="tsd-sources">
181
+ <ul>
182
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3235">services.ts:3235</a></li>
183
+ </ul>
184
+ </aside>
185
+ <div class="tsd-comment tsd-typography">
186
+ <div class="lead">
187
+ <p>List all online tunnel sessions running on this account.</p>
188
+ </div>
189
+ </div>
190
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.TunnelSession.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSession</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
191
+ </li>
192
+ </ul>
193
+ </section>
194
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
195
+ <a name="restart" class="tsd-anchor"></a>
196
+ <h3>restart</h3>
197
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
198
+ <li class="tsd-signature tsd-kind-icon">restart<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>
199
+ </ul>
200
+ <ul class="tsd-descriptions">
201
+ <li class="tsd-description">
202
+ <aside class="tsd-sources">
203
+ <ul>
204
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3288">services.ts:3288</a></li>
205
+ </ul>
206
+ </aside>
207
+ <div class="tsd-comment tsd-typography">
208
+ <div class="lead">
209
+ <p>Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.</p>
210
+ </div>
211
+ </div>
212
+ <h4 class="tsd-parameters-title">Parameters</h4>
213
+ <ul class="tsd-parameters">
214
+ <li>
215
+ <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
216
+ </li>
217
+ </ul>
218
+ <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>
219
+ </li>
220
+ </ul>
221
+ </section>
222
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
223
+ <a name="stop" class="tsd-anchor"></a>
224
+ <h3>stop</h3>
225
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
226
+ <li class="tsd-signature tsd-kind-icon">stop<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>
227
+ </ul>
228
+ <ul class="tsd-descriptions">
229
+ <li class="tsd-description">
230
+ <aside class="tsd-sources">
231
+ <ul>
232
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3299">services.ts:3299</a></li>
233
+ </ul>
234
+ </aside>
235
+ <div class="tsd-comment tsd-typography">
236
+ <div class="lead">
237
+ <p>Issues a command instructing the ngrok agent that started this tunnel session to exit.</p>
238
+ </div>
239
+ </div>
240
+ <h4 class="tsd-parameters-title">Parameters</h4>
241
+ <ul class="tsd-parameters">
242
+ <li>
243
+ <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
244
+ </li>
245
+ </ul>
246
+ <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>
247
+ </li>
248
+ </ul>
249
+ </section>
250
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
251
+ <a name="update" class="tsd-anchor"></a>
252
+ <h3>update</h3>
253
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
254
+ <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.TunnelSessionsUpdate.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSessionsUpdate</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>
255
+ </ul>
256
+ <ul class="tsd-descriptions">
257
+ <li class="tsd-description">
258
+ <aside class="tsd-sources">
259
+ <ul>
260
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3310">services.ts:3310</a></li>
261
+ </ul>
262
+ </aside>
263
+ <div class="tsd-comment tsd-typography">
264
+ <div class="lead">
265
+ <p>Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent&#39;s configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted</p>
266
+ </div>
267
+ </div>
268
+ <h4 class="tsd-parameters-title">Parameters</h4>
269
+ <ul class="tsd-parameters">
270
+ <li>
271
+ <h5>arg: <a href="../interfaces/datatypes.TunnelSessionsUpdate.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSessionsUpdate</a></h5>
272
+ </li>
273
+ </ul>
274
+ <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>
275
+ </li>
276
+ </ul>
277
+ </section>
278
+ </section>
279
+ </div>
280
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
281
+ <nav class="tsd-navigation primary">
282
+ <ul>
283
+ <li class=" ">
284
+ <a href="../modules.html">Modules</a>
285
+ </li>
286
+ <li class=" tsd-kind-module">
287
+ <a href="../modules/client.html">client</a>
288
+ </li>
289
+ <li class=" tsd-kind-module">
290
+ <a href="../modules/datatypes.html">datatypes</a>
291
+ </li>
292
+ <li class="current tsd-kind-module">
293
+ <a href="../modules/services.html">services</a>
294
+ </li>
295
+ </ul>
296
+ </nav>
297
+ <nav class="tsd-navigation secondary menu-sticky">
298
+ <ul class="before-current">
299
+ </ul>
300
+ <ul class="current">
301
+ <li class="current tsd-kind-class tsd-parent-kind-module">
302
+ <a href="services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a>
303
+ <ul>
304
+ <li class=" tsd-kind-constructor tsd-parent-kind-class">
305
+ <a href="services.TunnelSessions.html#constructor" class="tsd-kind-icon">constructor</a>
306
+ </li>
307
+ <li class=" tsd-kind-method tsd-parent-kind-class">
308
+ <a href="services.TunnelSessions.html#get" class="tsd-kind-icon">get</a>
309
+ </li>
310
+ <li class=" tsd-kind-method tsd-parent-kind-class">
311
+ <a href="services.TunnelSessions.html#list" class="tsd-kind-icon">list</a>
312
+ </li>
313
+ <li class=" tsd-kind-method tsd-parent-kind-class">
314
+ <a href="services.TunnelSessions.html#restart" class="tsd-kind-icon">restart</a>
315
+ </li>
316
+ <li class=" tsd-kind-method tsd-parent-kind-class">
317
+ <a href="services.TunnelSessions.html#stop" class="tsd-kind-icon">stop</a>
318
+ </li>
319
+ <li class=" tsd-kind-method tsd-parent-kind-class">
320
+ <a href="services.TunnelSessions.html#update" class="tsd-kind-icon">update</a>
321
+ </li>
322
+ </ul>
323
+ </li>
324
+ </ul>
325
+ <ul class="after-current">
326
+ </ul>
327
+ </nav>
328
+ </div>
329
+ </div>
330
+ </div>
331
+ <footer class="with-border-bottom">
332
+ <div class="container">
333
+ <h2>Legend</h2>
334
+ <div class="tsd-legend-group">
335
+ <ul class="tsd-legend">
336
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
337
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
338
+ <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
339
+ </ul>
340
+ <ul class="tsd-legend">
341
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
342
+ </ul>
343
+ </div>
344
+ </div>
345
+ </footer>
346
+ <div class="container tsd-generator">
347
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
348
+ </div>
349
+ <div class="overlay"></div>
350
+ <script src="../assets/js/main.js"></script>
351
+ </body>
352
+ </html>
package/docs/classes/services.Tunnels.html ADDED
@@ -0,0 +1,255 @@
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>Tunnels | @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.Tunnels.html">Tunnels</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Class Tunnels</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>Tunnels provide endpoints to access services exposed by a running ngrok
75
+ agent tunnel session or an SSH reverse tunnel session.</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">Tunnels</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.Tunnels.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.Tunnels.html#get" class="tsd-kind-icon">get</a></li>
101
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.Tunnels.html#list" class="tsd-kind-icon">list</a></li>
102
+ </ul>
103
+ </section>
104
+ </div>
105
+ </section>
106
+ </section>
107
+ <section class="tsd-panel-group tsd-member-group ">
108
+ <h2>Constructors</h2>
109
+ <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
110
+ <a name="constructor" class="tsd-anchor"></a>
111
+ <h3>constructor</h3>
112
+ <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
113
+ <li class="tsd-signature tsd-kind-icon">new <wbr>Tunnels<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.Tunnels.html" class="tsd-signature-type" data-tsd-kind="Class">Tunnels</a></li>
114
+ </ul>
115
+ <ul class="tsd-descriptions">
116
+ <li class="tsd-description">
117
+ <aside class="tsd-sources">
118
+ <ul>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3327">services.ts:3327</a></li>
120
+ </ul>
121
+ </aside>
122
+ <div class="tsd-comment tsd-typography">
123
+ <div class="lead">
124
+ <p>Do not construct this object directly, use the <code>tunnels</code> property of an <code>Ngrok</code> client object instead.</p>
125
+ </div>
126
+ </div>
127
+ <h4 class="tsd-parameters-title">Parameters</h4>
128
+ <ul class="tsd-parameters">
129
+ <li>
130
+ <h5>httpClient: <span class="tsd-signature-type">Wretcher</span></h5>
131
+ </li>
132
+ </ul>
133
+ <h4 class="tsd-returns-title">Returns <a href="services.Tunnels.html" class="tsd-signature-type" data-tsd-kind="Class">Tunnels</a></h4>
134
+ </li>
135
+ </ul>
136
+ </section>
137
+ </section>
138
+ <section class="tsd-panel-group tsd-member-group ">
139
+ <h2>Methods</h2>
140
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
141
+ <a name="get" class="tsd-anchor"></a>
142
+ <h3>get</h3>
143
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
144
+ <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.Tunnel.html" class="tsd-signature-type" data-tsd-kind="Interface">Tunnel</a><span class="tsd-signature-symbol">&gt;</span></li>
145
+ </ul>
146
+ <ul class="tsd-descriptions">
147
+ <li class="tsd-description">
148
+ <aside class="tsd-sources">
149
+ <ul>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3373">services.ts:3373</a></li>
151
+ </ul>
152
+ </aside>
153
+ <div class="tsd-comment tsd-typography">
154
+ <div class="lead">
155
+ <p>Get the status of a tunnel by ID</p>
156
+ </div>
157
+ </div>
158
+ <h4 class="tsd-parameters-title">Parameters</h4>
159
+ <ul class="tsd-parameters">
160
+ <li>
161
+ <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
162
+ </li>
163
+ </ul>
164
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.Tunnel.html" class="tsd-signature-type" data-tsd-kind="Interface">Tunnel</a><span class="tsd-signature-symbol">&gt;</span></h4>
165
+ </li>
166
+ </ul>
167
+ </section>
168
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
169
+ <a name="list" class="tsd-anchor"></a>
170
+ <h3>list</h3>
171
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
172
+ <li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</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.Tunnel.html" class="tsd-signature-type" data-tsd-kind="Interface">Tunnel</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
173
+ </ul>
174
+ <ul class="tsd-descriptions">
175
+ <li class="tsd-description">
176
+ <aside class="tsd-sources">
177
+ <ul>
178
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3333">services.ts:3333</a></li>
179
+ </ul>
180
+ </aside>
181
+ <div class="tsd-comment tsd-typography">
182
+ <div class="lead">
183
+ <p>List all online tunnels currently running on the account.</p>
184
+ </div>
185
+ </div>
186
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.Tunnel.html" class="tsd-signature-type" data-tsd-kind="Interface">Tunnel</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
187
+ </li>
188
+ </ul>
189
+ </section>
190
+ </section>
191
+ </div>
192
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
193
+ <nav class="tsd-navigation primary">
194
+ <ul>
195
+ <li class=" ">
196
+ <a href="../modules.html">Modules</a>
197
+ </li>
198
+ <li class=" tsd-kind-module">
199
+ <a href="../modules/client.html">client</a>
200
+ </li>
201
+ <li class=" tsd-kind-module">
202
+ <a href="../modules/datatypes.html">datatypes</a>
203
+ </li>
204
+ <li class="current tsd-kind-module">
205
+ <a href="../modules/services.html">services</a>
206
+ </li>
207
+ </ul>
208
+ </nav>
209
+ <nav class="tsd-navigation secondary menu-sticky">
210
+ <ul class="before-current">
211
+ </ul>
212
+ <ul class="current">
213
+ <li class="current tsd-kind-class tsd-parent-kind-module">
214
+ <a href="services.Tunnels.html" class="tsd-kind-icon">Tunnels</a>
215
+ <ul>
216
+ <li class=" tsd-kind-constructor tsd-parent-kind-class">
217
+ <a href="services.Tunnels.html#constructor" class="tsd-kind-icon">constructor</a>
218
+ </li>
219
+ <li class=" tsd-kind-method tsd-parent-kind-class">
220
+ <a href="services.Tunnels.html#get" class="tsd-kind-icon">get</a>
221
+ </li>
222
+ <li class=" tsd-kind-method tsd-parent-kind-class">
223
+ <a href="services.Tunnels.html#list" class="tsd-kind-icon">list</a>
224
+ </li>
225
+ </ul>
226
+ </li>
227
+ </ul>
228
+ <ul class="after-current">
229
+ </ul>
230
+ </nav>
231
+ </div>
232
+ </div>
233
+ </div>
234
+ <footer class="with-border-bottom">
235
+ <div class="container">
236
+ <h2>Legend</h2>
237
+ <div class="tsd-legend-group">
238
+ <ul class="tsd-legend">
239
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
240
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
241
+ <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
242
+ </ul>
243
+ <ul class="tsd-legend">
244
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
245
+ </ul>
246
+ </div>
247
+ </div>
248
+ </footer>
249
+ <div class="container tsd-generator">
250
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
251
+ </div>
252
+ <div class="overlay"></div>
253
+ <script src="../assets/js/main.js"></script>
254
+ </body>
255
+ </html>