@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/{tlsedge.html → datatypes.TCPEdge.html} RENAMED
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta charset="utf-8">
5
5
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>TLSEdge | @ngrok/ngrok-api</title>
6
+ <title>TCPEdge | @ngrok/ngrok-api</title>
7
7
  <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
8
  <meta name="viewport" content="width=device-width, initial-scale=1">
9
9
  <link rel="stylesheet" href="../assets/css/main.css">
@@ -55,10 +55,13 @@
55
55
  <a href="../modules.html">@ngrok/ngrok-api</a>
56
56
  </li>
57
57
  <li>
58
- <a href="tlsedge.html">TLSEdge</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.TCPEdge.html">TCPEdge</a>
59
62
  </li>
60
63
  </ul>
61
- <h1>Interface TLSEdge</h1>
64
+ <h1>Interface TCPEdge</h1>
62
65
  </div>
63
66
  </div>
64
67
  </header>
@@ -69,7 +72,7 @@
69
72
  <h3>Hierarchy</h3>
70
73
  <ul class="tsd-hierarchy">
71
74
  <li>
72
- <span class="target">TLSEdge</span>
75
+ <span class="target">TCPEdge</span>
73
76
  </li>
74
77
  </ul>
75
78
  </section>
@@ -80,15 +83,14 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedge.html#backend" class="tsd-kind-icon">backend</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedge.html#created_at" class="tsd-kind-icon">created_<wbr>at</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedge.html#description" class="tsd-kind-icon">description</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedge.html#id" class="tsd-kind-icon">id</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedge.html#ip_restriction" class="tsd-kind-icon">ip_<wbr>restriction</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedge.html#metadata" class="tsd-kind-icon">metadata</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedge.html#mutual_tls" class="tsd-kind-icon">mutual_<wbr>tls</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedge.html#tls_termination" class="tsd-kind-icon">tls_<wbr>termination</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedge.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdge.html#backend" class="tsd-kind-icon">backend</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdge.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdge.html#description" class="tsd-kind-icon">description</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdge.html#hostports" class="tsd-kind-icon">hostports</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdge.html#id" class="tsd-kind-icon">id</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdge.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdge.html#metadata" class="tsd-kind-icon">metadata</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdge.html#uri" class="tsd-kind-icon">uri</a></li>
92
94
  </ul>
93
95
  </section>
94
96
  </div>
@@ -99,10 +101,10 @@
99
101
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
100
102
  <a name="backend" class="tsd-anchor"></a>
101
103
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> backend</h3>
102
- <div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="endpointbackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a></div>
104
+ <div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a></div>
103
105
  <aside class="tsd-sources">
104
106
  <ul>
105
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L815">types.ts:815</a></li>
107
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1005">datatypes.ts:1005</a></li>
106
108
  </ul>
107
109
  </aside>
108
110
  <div class="tsd-comment tsd-typography">
@@ -112,17 +114,17 @@
112
114
  </div>
113
115
  </section>
114
116
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
115
- <a name="created_at" class="tsd-anchor"></a>
116
- <h3>created_<wbr>at</h3>
117
- <div class="tsd-signature tsd-kind-icon">created_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
117
+ <a name="createdAt" class="tsd-anchor"></a>
118
+ <h3>created<wbr>At</h3>
119
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
118
120
  <aside class="tsd-sources">
119
121
  <ul>
120
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L811">types.ts:811</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L999">datatypes.ts:999</a></li>
121
123
  </ul>
122
124
  </aside>
123
125
  <div class="tsd-comment tsd-typography">
124
126
  <div class="lead">
125
- <p>timestamp when the edge configuration was created, RFC 3339 format</p>
127
+ <p>timestamp when the edge was created, RFC 3339 format</p>
126
128
  </div>
127
129
  </div>
128
130
  </section>
@@ -132,12 +134,27 @@
132
134
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
133
135
  <aside class="tsd-sources">
134
136
  <ul>
135
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L807">types.ts:807</a></li>
137
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L995">datatypes.ts:995</a></li>
138
+ </ul>
139
+ </aside>
140
+ <div class="tsd-comment tsd-typography">
141
+ <div class="lead">
142
+ <p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
143
+ </div>
144
+ </div>
145
+ </section>
146
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
147
+ <a name="hostports" class="tsd-anchor"></a>
148
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> hostports</h3>
149
+ <div class="tsd-signature tsd-kind-icon">hostports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
150
+ <aside class="tsd-sources">
151
+ <ul>
152
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1003">datatypes.ts:1003</a></li>
136
153
  </ul>
137
154
  </aside>
138
155
  <div class="tsd-comment tsd-typography">
139
156
  <div class="lead">
140
- <p>human-readable description of what this edge will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p>
157
+ <p>hostports served by this edge</p>
141
158
  </div>
142
159
  </div>
143
160
  </section>
@@ -147,7 +164,7 @@
147
164
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
148
165
  <aside class="tsd-sources">
149
166
  <ul>
150
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L805">types.ts:805</a></li>
167
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L993">datatypes.ts:993</a></li>
151
168
  </ul>
152
169
  </aside>
153
170
  <div class="tsd-comment tsd-typography">
@@ -157,12 +174,12 @@
157
174
  </div>
158
175
  </section>
159
176
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
160
- <a name="ip_restriction" class="tsd-anchor"></a>
161
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip_<wbr>restriction</h3>
162
- <div class="tsd-signature tsd-kind-icon">ip_<wbr>restriction<span class="tsd-signature-symbol">:</span> <a href="endpointippolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a></div>
177
+ <a name="ipRestriction" class="tsd-anchor"></a>
178
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip<wbr>Restriction</h3>
179
+ <div class="tsd-signature tsd-kind-icon">ip<wbr>Restriction<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a></div>
163
180
  <aside class="tsd-sources">
164
181
  <ul>
165
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L816">types.ts:816</a></li>
182
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1006">datatypes.ts:1006</a></li>
166
183
  </ul>
167
184
  </aside>
168
185
  </section>
@@ -172,7 +189,7 @@
172
189
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
173
190
  <aside class="tsd-sources">
174
191
  <ul>
175
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L809">types.ts:809</a></li>
192
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L997">datatypes.ts:997</a></li>
176
193
  </ul>
177
194
  </aside>
178
195
  <div class="tsd-comment tsd-typography">
@@ -181,33 +198,13 @@
181
198
  </div>
182
199
  </div>
183
200
  </section>
184
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
185
- <a name="mutual_tls" class="tsd-anchor"></a>
186
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> mutual_<wbr>tls</h3>
187
- <div class="tsd-signature tsd-kind-icon">mutual_<wbr>tls<span class="tsd-signature-symbol">:</span> <a href="endpointmutualtls.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLS</a></div>
188
- <aside class="tsd-sources">
189
- <ul>
190
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L817">types.ts:817</a></li>
191
- </ul>
192
- </aside>
193
- </section>
194
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
195
- <a name="tls_termination" class="tsd-anchor"></a>
196
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> tls_<wbr>termination</h3>
197
- <div class="tsd-signature tsd-kind-icon">tls_<wbr>termination<span class="tsd-signature-symbol">:</span> <a href="endpointtlstermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</a></div>
198
- <aside class="tsd-sources">
199
- <ul>
200
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L818">types.ts:818</a></li>
201
- </ul>
202
- </aside>
203
- </section>
204
201
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
205
202
  <a name="uri" class="tsd-anchor"></a>
206
203
  <h3>uri</h3>
207
204
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
208
205
  <aside class="tsd-sources">
209
206
  <ul>
210
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L813">types.ts:813</a></li>
207
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1001">datatypes.ts:1001</a></li>
211
208
  </ul>
212
209
  </aside>
213
210
  <div class="tsd-comment tsd-typography">
@@ -222,7 +219,16 @@
222
219
  <nav class="tsd-navigation primary">
223
220
  <ul>
224
221
  <li class=" ">
225
- <a href="../modules.html">Exports</a>
222
+ <a href="../modules.html">Modules</a>
223
+ </li>
224
+ <li class=" tsd-kind-module">
225
+ <a href="../modules/client.html">client</a>
226
+ </li>
227
+ <li class="current tsd-kind-module">
228
+ <a href="../modules/datatypes.html">datatypes</a>
229
+ </li>
230
+ <li class=" tsd-kind-module">
231
+ <a href="../modules/services.html">services</a>
226
232
  </li>
227
233
  </ul>
228
234
  </nav>
@@ -230,35 +236,32 @@
230
236
  <ul class="before-current">
231
237
  </ul>
232
238
  <ul class="current">
233
- <li class="current tsd-kind-interface">
234
- <a href="tlsedge.html" class="tsd-kind-icon">TLSEdge</a>
239
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
240
+ <a href="datatypes.TCPEdge.html" class="tsd-kind-icon">TCPEdge</a>
235
241
  <ul>
236
242
  <li class=" tsd-kind-property tsd-parent-kind-interface">
237
- <a href="tlsedge.html#backend" class="tsd-kind-icon">backend</a>
243
+ <a href="datatypes.TCPEdge.html#backend" class="tsd-kind-icon">backend</a>
238
244
  </li>
239
245
  <li class=" tsd-kind-property tsd-parent-kind-interface">
240
- <a href="tlsedge.html#created_at" class="tsd-kind-icon">created_<wbr>at</a>
246
+ <a href="datatypes.TCPEdge.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
241
247
  </li>
242
248
  <li class=" tsd-kind-property tsd-parent-kind-interface">
243
- <a href="tlsedge.html#description" class="tsd-kind-icon">description</a>
249
+ <a href="datatypes.TCPEdge.html#description" class="tsd-kind-icon">description</a>
244
250
  </li>
245
251
  <li class=" tsd-kind-property tsd-parent-kind-interface">
246
- <a href="tlsedge.html#id" class="tsd-kind-icon">id</a>
252
+ <a href="datatypes.TCPEdge.html#hostports" class="tsd-kind-icon">hostports</a>
247
253
  </li>
248
254
  <li class=" tsd-kind-property tsd-parent-kind-interface">
249
- <a href="tlsedge.html#ip_restriction" class="tsd-kind-icon">ip_<wbr>restriction</a>
255
+ <a href="datatypes.TCPEdge.html#id" class="tsd-kind-icon">id</a>
250
256
  </li>
251
257
  <li class=" tsd-kind-property tsd-parent-kind-interface">
252
- <a href="tlsedge.html#metadata" class="tsd-kind-icon">metadata</a>
258
+ <a href="datatypes.TCPEdge.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a>
253
259
  </li>
254
260
  <li class=" tsd-kind-property tsd-parent-kind-interface">
255
- <a href="tlsedge.html#mutual_tls" class="tsd-kind-icon">mutual_<wbr>tls</a>
261
+ <a href="datatypes.TCPEdge.html#metadata" class="tsd-kind-icon">metadata</a>
256
262
  </li>
257
263
  <li class=" tsd-kind-property tsd-parent-kind-interface">
258
- <a href="tlsedge.html#tls_termination" class="tsd-kind-icon">tls_<wbr>termination</a>
259
- </li>
260
- <li class=" tsd-kind-property tsd-parent-kind-interface">
261
- <a href="tlsedge.html#uri" class="tsd-kind-icon">uri</a>
264
+ <a href="datatypes.TCPEdge.html#uri" class="tsd-kind-icon">uri</a>
262
265
  </li>
263
266
  </ul>
264
267
  </li>
@@ -274,11 +277,11 @@
274
277
  <h2>Legend</h2>
275
278
  <div class="tsd-legend-group">
276
279
  <ul class="tsd-legend">
277
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
278
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
280
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
281
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
279
282
  </ul>
280
283
  <ul class="tsd-legend">
281
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
284
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
282
285
  </ul>
283
286
  </div>
284
287
  </div>
package/docs/interfaces/{tlsedgecreate.html → datatypes.TCPEdgeCreate.html} RENAMED
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta charset="utf-8">
5
5
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>TLSEdgeCreate | @ngrok/ngrok-api</title>
6
+ <title>TCPEdgeCreate | @ngrok/ngrok-api</title>
7
7
  <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
8
  <meta name="viewport" content="width=device-width, initial-scale=1">
9
9
  <link rel="stylesheet" href="../assets/css/main.css">
@@ -55,10 +55,13 @@
55
55
  <a href="../modules.html">@ngrok/ngrok-api</a>
56
56
  </li>
57
57
  <li>
58
- <a href="tlsedgecreate.html">TLSEdgeCreate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.TCPEdgeCreate.html">TCPEdgeCreate</a>
59
62
  </li>
60
63
  </ul>
61
- <h1>Interface TLSEdgeCreate</h1>
64
+ <h1>Interface TCPEdgeCreate</h1>
62
65
  </div>
63
66
  </div>
64
67
  </header>
@@ -69,7 +72,7 @@
69
72
  <h3>Hierarchy</h3>
70
73
  <ul class="tsd-hierarchy">
71
74
  <li>
72
- <span class="target">TLSEdgeCreate</span>
75
+ <span class="target">TCPEdgeCreate</span>
73
76
  </li>
74
77
  </ul>
75
78
  </section>
@@ -80,11 +83,11 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedgecreate.html#description" class="tsd-kind-icon">description</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedgecreate.html#ip_restriction" class="tsd-kind-icon">ip_<wbr>restriction</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedgecreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedgecreate.html#mutual_tls" class="tsd-kind-icon">mutual_<wbr>tls</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedgecreate.html#tls_termination" class="tsd-kind-icon">tls_<wbr>termination</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeCreate.html#backend" class="tsd-kind-icon">backend</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeCreate.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeCreate.html#hostports" class="tsd-kind-icon">hostports</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeCreate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
88
91
  </ul>
89
92
  </section>
90
93
  </div>
@@ -93,64 +96,74 @@
93
96
  <section class="tsd-panel-group tsd-member-group ">
94
97
  <h2>Properties</h2>
95
98
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
96
- <a name="description" class="tsd-anchor"></a>
97
- <h3>description</h3>
98
- <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
+ <a name="backend" class="tsd-anchor"></a>
100
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> backend</h3>
101
+ <div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackendMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackendMutate</a></div>
99
102
  <aside class="tsd-sources">
100
103
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L783">types.ts:783</a></li>
104
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L973">datatypes.ts:973</a></li>
102
105
  </ul>
103
106
  </aside>
104
107
  <div class="tsd-comment tsd-typography">
105
108
  <div class="lead">
106
- <p>human-readable description of what this edge will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p>
109
+ <p>edge modules</p>
107
110
  </div>
108
111
  </div>
109
112
  </section>
110
113
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
111
- <a name="ip_restriction" class="tsd-anchor"></a>
112
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip_<wbr>restriction</h3>
113
- <div class="tsd-signature tsd-kind-icon">ip_<wbr>restriction<span class="tsd-signature-symbol">:</span> <a href="endpointippolicymutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicyMutate</a></div>
114
+ <a name="description" class="tsd-anchor"></a>
115
+ <h3>description</h3>
116
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
114
117
  <aside class="tsd-sources">
115
118
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L786">types.ts:786</a></li>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L967">datatypes.ts:967</a></li>
117
120
  </ul>
118
121
  </aside>
122
+ <div class="tsd-comment tsd-typography">
123
+ <div class="lead">
124
+ <p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
125
+ </div>
126
+ </div>
119
127
  </section>
120
128
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
121
- <a name="metadata" class="tsd-anchor"></a>
122
- <h3>metadata</h3>
123
- <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
129
+ <a name="hostports" class="tsd-anchor"></a>
130
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> hostports</h3>
131
+ <div class="tsd-signature tsd-kind-icon">hostports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
124
132
  <aside class="tsd-sources">
125
133
  <ul>
126
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L785">types.ts:785</a></li>
134
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L971">datatypes.ts:971</a></li>
127
135
  </ul>
128
136
  </aside>
129
137
  <div class="tsd-comment tsd-typography">
130
138
  <div class="lead">
131
- <p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
139
+ <p>hostports served by this edge</p>
132
140
  </div>
133
141
  </div>
134
142
  </section>
135
143
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
136
- <a name="mutual_tls" class="tsd-anchor"></a>
137
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> mutual_<wbr>tls</h3>
138
- <div class="tsd-signature tsd-kind-icon">mutual_<wbr>tls<span class="tsd-signature-symbol">:</span> <a href="endpointmutualtlsmutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLSMutate</a></div>
144
+ <a name="ipRestriction" class="tsd-anchor"></a>
145
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip<wbr>Restriction</h3>
146
+ <div class="tsd-signature tsd-kind-icon">ip<wbr>Restriction<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicyMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicyMutate</a></div>
139
147
  <aside class="tsd-sources">
140
148
  <ul>
141
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L787">types.ts:787</a></li>
149
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L974">datatypes.ts:974</a></li>
142
150
  </ul>
143
151
  </aside>
144
152
  </section>
145
153
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
146
- <a name="tls_termination" class="tsd-anchor"></a>
147
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> tls_<wbr>termination</h3>
148
- <div class="tsd-signature tsd-kind-icon">tls_<wbr>termination<span class="tsd-signature-symbol">:</span> <a href="endpointtlstermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</a></div>
154
+ <a name="metadata" class="tsd-anchor"></a>
155
+ <h3>metadata</h3>
156
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
149
157
  <aside class="tsd-sources">
150
158
  <ul>
151
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L788">types.ts:788</a></li>
159
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L969">datatypes.ts:969</a></li>
152
160
  </ul>
153
161
  </aside>
162
+ <div class="tsd-comment tsd-typography">
163
+ <div class="lead">
164
+ <p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
165
+ </div>
166
+ </div>
154
167
  </section>
155
168
  </section>
156
169
  </div>
@@ -158,7 +171,16 @@
158
171
  <nav class="tsd-navigation primary">
159
172
  <ul>
160
173
  <li class=" ">
161
- <a href="../modules.html">Exports</a>
174
+ <a href="../modules.html">Modules</a>
175
+ </li>
176
+ <li class=" tsd-kind-module">
177
+ <a href="../modules/client.html">client</a>
178
+ </li>
179
+ <li class="current tsd-kind-module">
180
+ <a href="../modules/datatypes.html">datatypes</a>
181
+ </li>
182
+ <li class=" tsd-kind-module">
183
+ <a href="../modules/services.html">services</a>
162
184
  </li>
163
185
  </ul>
164
186
  </nav>
@@ -166,23 +188,23 @@
166
188
  <ul class="before-current">
167
189
  </ul>
168
190
  <ul class="current">
169
- <li class="current tsd-kind-interface">
170
- <a href="tlsedgecreate.html" class="tsd-kind-icon">TLSEdge<wbr>Create</a>
191
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
192
+ <a href="datatypes.TCPEdgeCreate.html" class="tsd-kind-icon">TCPEdge<wbr>Create</a>
171
193
  <ul>
172
194
  <li class=" tsd-kind-property tsd-parent-kind-interface">
173
- <a href="tlsedgecreate.html#description" class="tsd-kind-icon">description</a>
195
+ <a href="datatypes.TCPEdgeCreate.html#backend" class="tsd-kind-icon">backend</a>
174
196
  </li>
175
197
  <li class=" tsd-kind-property tsd-parent-kind-interface">
176
- <a href="tlsedgecreate.html#ip_restriction" class="tsd-kind-icon">ip_<wbr>restriction</a>
198
+ <a href="datatypes.TCPEdgeCreate.html#description" class="tsd-kind-icon">description</a>
177
199
  </li>
178
200
  <li class=" tsd-kind-property tsd-parent-kind-interface">
179
- <a href="tlsedgecreate.html#metadata" class="tsd-kind-icon">metadata</a>
201
+ <a href="datatypes.TCPEdgeCreate.html#hostports" class="tsd-kind-icon">hostports</a>
180
202
  </li>
181
203
  <li class=" tsd-kind-property tsd-parent-kind-interface">
182
- <a href="tlsedgecreate.html#mutual_tls" class="tsd-kind-icon">mutual_<wbr>tls</a>
204
+ <a href="datatypes.TCPEdgeCreate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a>
183
205
  </li>
184
206
  <li class=" tsd-kind-property tsd-parent-kind-interface">
185
- <a href="tlsedgecreate.html#tls_termination" class="tsd-kind-icon">tls_<wbr>termination</a>
207
+ <a href="datatypes.TCPEdgeCreate.html#metadata" class="tsd-kind-icon">metadata</a>
186
208
  </li>
187
209
  </ul>
188
210
  </li>
@@ -198,11 +220,11 @@
198
220
  <h2>Legend</h2>
199
221
  <div class="tsd-legend-group">
200
222
  <ul class="tsd-legend">
201
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
202
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
223
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
224
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
203
225
  </ul>
204
226
  <ul class="tsd-legend">
205
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
227
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
206
228
  </ul>
207
229
  </div>
208
230
  </div>