@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/interfaces/datatypes.Tunnel.html ADDED
@@ -0,0 +1,357 @@
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>Tunnel | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.Tunnel.html">Tunnel</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface Tunnel</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">Tunnel</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#backends" class="tsd-kind-icon">backends</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#endpoint" class="tsd-kind-icon">endpoint</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#forwardsTo" class="tsd-kind-icon">forwards<wbr>To</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#id" class="tsd-kind-icon">id</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#labels" class="tsd-kind-icon">labels</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#metadata" class="tsd-kind-icon">metadata</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#proto" class="tsd-kind-icon">proto</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#publicUrl" class="tsd-kind-icon">public<wbr>Url</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#region" class="tsd-kind-icon">region</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#startedAt" class="tsd-kind-icon">started<wbr>At</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Tunnel.html#tunnelSession" class="tsd-kind-icon">tunnel<wbr>Session</a></li>
97
+ </ul>
98
+ </section>
99
+ </div>
100
+ </section>
101
+ </section>
102
+ <section class="tsd-panel-group tsd-member-group ">
103
+ <h2>Properties</h2>
104
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
105
+ <a name="backends" class="tsd-anchor"></a>
106
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> backends</h3>
107
+ <div class="tsd-signature tsd-kind-icon">backends<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a><span class="tsd-signature-symbol">[]</span></div>
108
+ <aside class="tsd-sources">
109
+ <ul>
110
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1934">datatypes.ts:1934</a></li>
111
+ </ul>
112
+ </aside>
113
+ <div class="tsd-comment tsd-typography">
114
+ <div class="lead">
115
+ <p>tunnel group backends served by this backend tunnel</p>
116
+ </div>
117
+ </div>
118
+ </section>
119
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
120
+ <a name="endpoint" class="tsd-anchor"></a>
121
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> endpoint</h3>
122
+ <div class="tsd-signature tsd-kind-icon">endpoint<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
123
+ <aside class="tsd-sources">
124
+ <ul>
125
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1930">datatypes.ts:1930</a></li>
126
+ </ul>
127
+ </aside>
128
+ <div class="tsd-comment tsd-typography">
129
+ <div class="lead">
130
+ <p>the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel</p>
131
+ </div>
132
+ </div>
133
+ </section>
134
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
135
+ <a name="forwardsTo" class="tsd-anchor"></a>
136
+ <h3>forwards<wbr>To</h3>
137
+ <div class="tsd-signature tsd-kind-icon">forwards<wbr>To<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
138
+ <aside class="tsd-sources">
139
+ <ul>
140
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1936">datatypes.ts:1936</a></li>
141
+ </ul>
142
+ </aside>
143
+ <div class="tsd-comment tsd-typography">
144
+ <div class="lead">
145
+ <p>upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.</p>
146
+ </div>
147
+ </div>
148
+ </section>
149
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
150
+ <a name="id" class="tsd-anchor"></a>
151
+ <h3>id</h3>
152
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
153
+ <aside class="tsd-sources">
154
+ <ul>
155
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1916">datatypes.ts:1916</a></li>
156
+ </ul>
157
+ </aside>
158
+ <div class="tsd-comment tsd-typography">
159
+ <div class="lead">
160
+ <p>unique tunnel resource identifier</p>
161
+ </div>
162
+ </div>
163
+ </section>
164
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
165
+ <a name="labels" class="tsd-anchor"></a>
166
+ <h3>labels</h3>
167
+ <div class="tsd-signature tsd-kind-icon">labels<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
168
+ <aside class="tsd-sources">
169
+ <ul>
170
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1932">datatypes.ts:1932</a></li>
171
+ </ul>
172
+ </aside>
173
+ <div class="tsd-comment tsd-typography">
174
+ <div class="lead">
175
+ <p>the labels the tunnel group backends will match against, if this is a backend tunnel</p>
176
+ </div>
177
+ </div>
178
+ </section>
179
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
180
+ <a name="metadata" class="tsd-anchor"></a>
181
+ <h3>metadata</h3>
182
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
183
+ <aside class="tsd-sources">
184
+ <ul>
185
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1922">datatypes.ts:1922</a></li>
186
+ </ul>
187
+ </aside>
188
+ <div class="tsd-comment tsd-typography">
189
+ <div class="lead">
190
+ <p>user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel <a href="https://ngrok.com/docs#tunnel-definitions-metadata">metadata configuration option</a> In API version 0, this value was instead pulled from the top-level <a href="https://ngrok.com/docs#config_metadata">metadata configuration option</a>.</p>
191
+ </div>
192
+ </div>
193
+ </section>
194
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
195
+ <a name="proto" class="tsd-anchor"></a>
196
+ <h3>proto</h3>
197
+ <div class="tsd-signature tsd-kind-icon">proto<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
198
+ <aside class="tsd-sources">
199
+ <ul>
200
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1924">datatypes.ts:1924</a></li>
201
+ </ul>
202
+ </aside>
203
+ <div class="tsd-comment tsd-typography">
204
+ <div class="lead">
205
+ <p>tunnel protocol for ephemeral tunnels. one of <code>http</code>, <code>https</code>, <code>tcp</code> or <code>tls</code></p>
206
+ </div>
207
+ </div>
208
+ </section>
209
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
210
+ <a name="publicUrl" class="tsd-anchor"></a>
211
+ <h3>public<wbr>Url</h3>
212
+ <div class="tsd-signature tsd-kind-icon">public<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
213
+ <aside class="tsd-sources">
214
+ <ul>
215
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1918">datatypes.ts:1918</a></li>
216
+ </ul>
217
+ </aside>
218
+ <div class="tsd-comment tsd-typography">
219
+ <div class="lead">
220
+ <p>URL of the ephemeral tunnel&#39;s public endpoint</p>
221
+ </div>
222
+ </div>
223
+ </section>
224
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
225
+ <a name="region" class="tsd-anchor"></a>
226
+ <h3>region</h3>
227
+ <div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
228
+ <aside class="tsd-sources">
229
+ <ul>
230
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1926">datatypes.ts:1926</a></li>
231
+ </ul>
232
+ </aside>
233
+ <div class="tsd-comment tsd-typography">
234
+ <div class="lead">
235
+ <p>identifier of tune region where the tunnel is running</p>
236
+ </div>
237
+ </div>
238
+ </section>
239
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
240
+ <a name="startedAt" class="tsd-anchor"></a>
241
+ <h3>started<wbr>At</h3>
242
+ <div class="tsd-signature tsd-kind-icon">started<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
243
+ <aside class="tsd-sources">
244
+ <ul>
245
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1920">datatypes.ts:1920</a></li>
246
+ </ul>
247
+ </aside>
248
+ <div class="tsd-comment tsd-typography">
249
+ <div class="lead">
250
+ <p>timestamp when the tunnel was initiated in RFC 3339 format</p>
251
+ </div>
252
+ </div>
253
+ </section>
254
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
255
+ <a name="tunnelSession" class="tsd-anchor"></a>
256
+ <h3>tunnel<wbr>Session</h3>
257
+ <div class="tsd-signature tsd-kind-icon">tunnel<wbr>Session<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
258
+ <aside class="tsd-sources">
259
+ <ul>
260
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1928">datatypes.ts:1928</a></li>
261
+ </ul>
262
+ </aside>
263
+ <div class="tsd-comment tsd-typography">
264
+ <div class="lead">
265
+ <p>reference object pointing to the tunnel session on which this tunnel was started</p>
266
+ </div>
267
+ </div>
268
+ </section>
269
+ </section>
270
+ </div>
271
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
272
+ <nav class="tsd-navigation primary">
273
+ <ul>
274
+ <li class=" ">
275
+ <a href="../modules.html">Modules</a>
276
+ </li>
277
+ <li class=" tsd-kind-module">
278
+ <a href="../modules/client.html">client</a>
279
+ </li>
280
+ <li class="current tsd-kind-module">
281
+ <a href="../modules/datatypes.html">datatypes</a>
282
+ </li>
283
+ <li class=" tsd-kind-module">
284
+ <a href="../modules/services.html">services</a>
285
+ </li>
286
+ </ul>
287
+ </nav>
288
+ <nav class="tsd-navigation secondary menu-sticky">
289
+ <ul class="before-current">
290
+ </ul>
291
+ <ul class="current">
292
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
293
+ <a href="datatypes.Tunnel.html" class="tsd-kind-icon">Tunnel</a>
294
+ <ul>
295
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
296
+ <a href="datatypes.Tunnel.html#backends" class="tsd-kind-icon">backends</a>
297
+ </li>
298
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
299
+ <a href="datatypes.Tunnel.html#endpoint" class="tsd-kind-icon">endpoint</a>
300
+ </li>
301
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
302
+ <a href="datatypes.Tunnel.html#forwardsTo" class="tsd-kind-icon">forwards<wbr>To</a>
303
+ </li>
304
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
305
+ <a href="datatypes.Tunnel.html#id" class="tsd-kind-icon">id</a>
306
+ </li>
307
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
308
+ <a href="datatypes.Tunnel.html#labels" class="tsd-kind-icon">labels</a>
309
+ </li>
310
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
311
+ <a href="datatypes.Tunnel.html#metadata" class="tsd-kind-icon">metadata</a>
312
+ </li>
313
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
314
+ <a href="datatypes.Tunnel.html#proto" class="tsd-kind-icon">proto</a>
315
+ </li>
316
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
317
+ <a href="datatypes.Tunnel.html#publicUrl" class="tsd-kind-icon">public<wbr>Url</a>
318
+ </li>
319
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
320
+ <a href="datatypes.Tunnel.html#region" class="tsd-kind-icon">region</a>
321
+ </li>
322
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
323
+ <a href="datatypes.Tunnel.html#startedAt" class="tsd-kind-icon">started<wbr>At</a>
324
+ </li>
325
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
326
+ <a href="datatypes.Tunnel.html#tunnelSession" class="tsd-kind-icon">tunnel<wbr>Session</a>
327
+ </li>
328
+ </ul>
329
+ </li>
330
+ </ul>
331
+ <ul class="after-current">
332
+ </ul>
333
+ </nav>
334
+ </div>
335
+ </div>
336
+ </div>
337
+ <footer class="with-border-bottom">
338
+ <div class="container">
339
+ <h2>Legend</h2>
340
+ <div class="tsd-legend-group">
341
+ <ul class="tsd-legend">
342
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
343
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
344
+ </ul>
345
+ <ul class="tsd-legend">
346
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
347
+ </ul>
348
+ </div>
349
+ </div>
350
+ </footer>
351
+ <div class="container tsd-generator">
352
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
353
+ </div>
354
+ <div class="overlay"></div>
355
+ <script src="../assets/js/main.js"></script>
356
+ </body>
357
+ </html>
package/docs/interfaces/datatypes.TunnelGroupBackend.html ADDED
@@ -0,0 +1,281 @@
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>TunnelGroupBackend | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.TunnelGroupBackend.html">TunnelGroupBackend</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface TunnelGroupBackend</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">TunnelGroupBackend</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelGroupBackend.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelGroupBackend.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelGroupBackend.html#id" class="tsd-kind-icon">id</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelGroupBackend.html#labels" class="tsd-kind-icon">labels</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelGroupBackend.html#metadata" class="tsd-kind-icon">metadata</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelGroupBackend.html#tunnels" class="tsd-kind-icon">tunnels</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelGroupBackend.html#uri" class="tsd-kind-icon">uri</a></li>
93
+ </ul>
94
+ </section>
95
+ </div>
96
+ </section>
97
+ </section>
98
+ <section class="tsd-panel-group tsd-member-group ">
99
+ <h2>Properties</h2>
100
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
101
+ <a name="createdAt" class="tsd-anchor"></a>
102
+ <h3>created<wbr>At</h3>
103
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
104
+ <aside class="tsd-sources">
105
+ <ul>
106
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L242">datatypes.ts:242</a></li>
107
+ </ul>
108
+ </aside>
109
+ <div class="tsd-comment tsd-typography">
110
+ <div class="lead">
111
+ <p>timestamp when the backend was created, RFC 3339 format</p>
112
+ </div>
113
+ </div>
114
+ </section>
115
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
116
+ <a name="description" class="tsd-anchor"></a>
117
+ <h3>description</h3>
118
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
119
+ <aside class="tsd-sources">
120
+ <ul>
121
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L244">datatypes.ts:244</a></li>
122
+ </ul>
123
+ </aside>
124
+ <div class="tsd-comment tsd-typography">
125
+ <div class="lead">
126
+ <p>human-readable description of this backend. Optional</p>
127
+ </div>
128
+ </div>
129
+ </section>
130
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
131
+ <a name="id" class="tsd-anchor"></a>
132
+ <h3>id</h3>
133
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
134
+ <aside class="tsd-sources">
135
+ <ul>
136
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L238">datatypes.ts:238</a></li>
137
+ </ul>
138
+ </aside>
139
+ <div class="tsd-comment tsd-typography">
140
+ <div class="lead">
141
+ <p>unique identifier for this TunnelGroup backend</p>
142
+ </div>
143
+ </div>
144
+ </section>
145
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
146
+ <a name="labels" class="tsd-anchor"></a>
147
+ <h3>labels</h3>
148
+ <div class="tsd-signature tsd-kind-icon">labels<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
149
+ <aside class="tsd-sources">
150
+ <ul>
151
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L248">datatypes.ts:248</a></li>
152
+ </ul>
153
+ </aside>
154
+ <div class="tsd-comment tsd-typography">
155
+ <div class="lead">
156
+ <p>labels to watch for tunnels on, e.g. app-&gt;foo, dc-&gt;bar</p>
157
+ </div>
158
+ </div>
159
+ </section>
160
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
161
+ <a name="metadata" class="tsd-anchor"></a>
162
+ <h3>metadata</h3>
163
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
164
+ <aside class="tsd-sources">
165
+ <ul>
166
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L246">datatypes.ts:246</a></li>
167
+ </ul>
168
+ </aside>
169
+ <div class="tsd-comment tsd-typography">
170
+ <div class="lead">
171
+ <p>arbitrary user-defined machine-readable data of this backend. Optional</p>
172
+ </div>
173
+ </div>
174
+ </section>
175
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
176
+ <a name="tunnels" class="tsd-anchor"></a>
177
+ <h3>tunnels</h3>
178
+ <div class="tsd-signature tsd-kind-icon">tunnels<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a><span class="tsd-signature-symbol">[]</span></div>
179
+ <aside class="tsd-sources">
180
+ <ul>
181
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L250">datatypes.ts:250</a></li>
182
+ </ul>
183
+ </aside>
184
+ <div class="tsd-comment tsd-typography">
185
+ <div class="lead">
186
+ <p>tunnels matching this backend</p>
187
+ </div>
188
+ </div>
189
+ </section>
190
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
191
+ <a name="uri" class="tsd-anchor"></a>
192
+ <h3>uri</h3>
193
+ <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
194
+ <aside class="tsd-sources">
195
+ <ul>
196
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L240">datatypes.ts:240</a></li>
197
+ </ul>
198
+ </aside>
199
+ <div class="tsd-comment tsd-typography">
200
+ <div class="lead">
201
+ <p>URI of the TunnelGroupBackend API resource</p>
202
+ </div>
203
+ </div>
204
+ </section>
205
+ </section>
206
+ </div>
207
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
208
+ <nav class="tsd-navigation primary">
209
+ <ul>
210
+ <li class=" ">
211
+ <a href="../modules.html">Modules</a>
212
+ </li>
213
+ <li class=" tsd-kind-module">
214
+ <a href="../modules/client.html">client</a>
215
+ </li>
216
+ <li class="current tsd-kind-module">
217
+ <a href="../modules/datatypes.html">datatypes</a>
218
+ </li>
219
+ <li class=" tsd-kind-module">
220
+ <a href="../modules/services.html">services</a>
221
+ </li>
222
+ </ul>
223
+ </nav>
224
+ <nav class="tsd-navigation secondary menu-sticky">
225
+ <ul class="before-current">
226
+ </ul>
227
+ <ul class="current">
228
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
229
+ <a href="datatypes.TunnelGroupBackend.html" class="tsd-kind-icon">Tunnel<wbr>Group<wbr>Backend</a>
230
+ <ul>
231
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
232
+ <a href="datatypes.TunnelGroupBackend.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
233
+ </li>
234
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
235
+ <a href="datatypes.TunnelGroupBackend.html#description" class="tsd-kind-icon">description</a>
236
+ </li>
237
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
238
+ <a href="datatypes.TunnelGroupBackend.html#id" class="tsd-kind-icon">id</a>
239
+ </li>
240
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
241
+ <a href="datatypes.TunnelGroupBackend.html#labels" class="tsd-kind-icon">labels</a>
242
+ </li>
243
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
244
+ <a href="datatypes.TunnelGroupBackend.html#metadata" class="tsd-kind-icon">metadata</a>
245
+ </li>
246
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
247
+ <a href="datatypes.TunnelGroupBackend.html#tunnels" class="tsd-kind-icon">tunnels</a>
248
+ </li>
249
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
250
+ <a href="datatypes.TunnelGroupBackend.html#uri" class="tsd-kind-icon">uri</a>
251
+ </li>
252
+ </ul>
253
+ </li>
254
+ </ul>
255
+ <ul class="after-current">
256
+ </ul>
257
+ </nav>
258
+ </div>
259
+ </div>
260
+ </div>
261
+ <footer class="with-border-bottom">
262
+ <div class="container">
263
+ <h2>Legend</h2>
264
+ <div class="tsd-legend-group">
265
+ <ul class="tsd-legend">
266
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
267
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
268
+ </ul>
269
+ <ul class="tsd-legend">
270
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
271
+ </ul>
272
+ </div>
273
+ </div>
274
+ </footer>
275
+ <div class="container tsd-generator">
276
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
277
+ </div>
278
+ <div class="overlay"></div>
279
+ <script src="../assets/js/main.js"></script>
280
+ </body>
281
+ </html>