@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/{tcpedge.html → datatypes.HTTPResponseBackendUpdate.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>TCPEdge | @ngrok/ngrok-api</title>
6
+ <title>HTTPResponseBackendUpdate | @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="tcpedge.html">TCPEdge</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.HTTPResponseBackendUpdate.html">HTTPResponseBackendUpdate</a>
59
62
  </li>
60
63
  </ul>
61
- <h1>Interface TCPEdge</h1>
64
+ <h1>Interface HTTPResponseBackendUpdate</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">TCPEdge</span>
75
+ <span class="target">HTTPResponseBackendUpdate</span>
73
76
  </li>
74
77
  </ul>
75
78
  </section>
@@ -80,13 +83,12 @@
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="tcpedge.html#backend" class="tsd-kind-icon">backend</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tcpedge.html#created_at" class="tsd-kind-icon">created_<wbr>at</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tcpedge.html#description" class="tsd-kind-icon">description</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tcpedge.html#id" class="tsd-kind-icon">id</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tcpedge.html#ip_restriction" class="tsd-kind-icon">ip_<wbr>restriction</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tcpedge.html#metadata" class="tsd-kind-icon">metadata</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tcpedge.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPResponseBackendUpdate.html#body" class="tsd-kind-icon">body</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPResponseBackendUpdate.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPResponseBackendUpdate.html#headers" class="tsd-kind-icon">headers</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPResponseBackendUpdate.html#id" class="tsd-kind-icon">id</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPResponseBackendUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPResponseBackendUpdate.html#statusCode" class="tsd-kind-icon">status<wbr>Code</a></li>
90
92
  </ul>
91
93
  </section>
92
94
  </div>
@@ -95,47 +97,47 @@
95
97
  <section class="tsd-panel-group tsd-member-group ">
96
98
  <h2>Properties</h2>
97
99
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
98
- <a name="backend" class="tsd-anchor"></a>
99
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> backend</h3>
100
- <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>
100
+ <a name="body" class="tsd-anchor"></a>
101
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> body</h3>
102
+ <div class="tsd-signature tsd-kind-icon">body<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
101
103
  <aside class="tsd-sources">
102
104
  <ul>
103
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L777">types.ts:777</a></li>
105
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L223">datatypes.ts:223</a></li>
104
106
  </ul>
105
107
  </aside>
106
108
  <div class="tsd-comment tsd-typography">
107
109
  <div class="lead">
108
- <p>edge modules</p>
110
+ <p>body to return as fixed content</p>
109
111
  </div>
110
112
  </div>
111
113
  </section>
112
114
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
113
- <a name="created_at" class="tsd-anchor"></a>
114
- <h3>created_<wbr>at</h3>
115
- <div class="tsd-signature tsd-kind-icon">created_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
115
+ <a name="description" class="tsd-anchor"></a>
116
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
117
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
116
118
  <aside class="tsd-sources">
117
119
  <ul>
118
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L773">types.ts:773</a></li>
120
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L219">datatypes.ts:219</a></li>
119
121
  </ul>
120
122
  </aside>
121
123
  <div class="tsd-comment tsd-typography">
122
124
  <div class="lead">
123
- <p>timestamp when the edge was created, RFC 3339 format</p>
125
+ <p>human-readable description of this backend. Optional</p>
124
126
  </div>
125
127
  </div>
126
128
  </section>
127
129
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
128
- <a name="description" class="tsd-anchor"></a>
129
- <h3>description</h3>
130
- <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130
+ <a name="headers" class="tsd-anchor"></a>
131
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> headers</h3>
132
+ <div class="tsd-signature tsd-kind-icon">headers<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>
131
133
  <aside class="tsd-sources">
132
134
  <ul>
133
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L769">types.ts:769</a></li>
135
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L225">datatypes.ts:225</a></li>
134
136
  </ul>
135
137
  </aside>
136
138
  <div class="tsd-comment tsd-typography">
137
139
  <div class="lead">
138
- <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>
140
+ <p>headers to return</p>
139
141
  </div>
140
142
  </div>
141
143
  </section>
@@ -145,52 +147,37 @@
145
147
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
146
148
  <aside class="tsd-sources">
147
149
  <ul>
148
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L767">types.ts:767</a></li>
149
- </ul>
150
- </aside>
151
- <div class="tsd-comment tsd-typography">
152
- <div class="lead">
153
- <p>unique identifier of this edge</p>
154
- </div>
155
- </div>
156
- </section>
157
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
158
- <a name="ip_restriction" class="tsd-anchor"></a>
159
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip_<wbr>restriction</h3>
160
- <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>
161
- <aside class="tsd-sources">
162
- <ul>
163
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L778">types.ts:778</a></li>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L217">datatypes.ts:217</a></li>
164
151
  </ul>
165
152
  </aside>
166
153
  </section>
167
154
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
168
155
  <a name="metadata" class="tsd-anchor"></a>
169
- <h3>metadata</h3>
156
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
170
157
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
171
158
  <aside class="tsd-sources">
172
159
  <ul>
173
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L771">types.ts:771</a></li>
160
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L221">datatypes.ts:221</a></li>
174
161
  </ul>
175
162
  </aside>
176
163
  <div class="tsd-comment tsd-typography">
177
164
  <div class="lead">
178
- <p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
165
+ <p>arbitrary user-defined machine-readable data of this backend. Optional</p>
179
166
  </div>
180
167
  </div>
181
168
  </section>
182
169
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
183
- <a name="uri" class="tsd-anchor"></a>
184
- <h3>uri</h3>
185
- <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
170
+ <a name="statusCode" class="tsd-anchor"></a>
171
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> status<wbr>Code</h3>
172
+ <div class="tsd-signature tsd-kind-icon">status<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
186
173
  <aside class="tsd-sources">
187
174
  <ul>
188
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L775">types.ts:775</a></li>
175
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L227">datatypes.ts:227</a></li>
189
176
  </ul>
190
177
  </aside>
191
178
  <div class="tsd-comment tsd-typography">
192
179
  <div class="lead">
193
- <p>URI of the edge API resource</p>
180
+ <p>status code to return</p>
194
181
  </div>
195
182
  </div>
196
183
  </section>
@@ -200,7 +187,16 @@
200
187
  <nav class="tsd-navigation primary">
201
188
  <ul>
202
189
  <li class=" ">
203
- <a href="../modules.html">Exports</a>
190
+ <a href="../modules.html">Modules</a>
191
+ </li>
192
+ <li class=" tsd-kind-module">
193
+ <a href="../modules/client.html">client</a>
194
+ </li>
195
+ <li class="current tsd-kind-module">
196
+ <a href="../modules/datatypes.html">datatypes</a>
197
+ </li>
198
+ <li class=" tsd-kind-module">
199
+ <a href="../modules/services.html">services</a>
204
200
  </li>
205
201
  </ul>
206
202
  </nav>
@@ -208,29 +204,26 @@
208
204
  <ul class="before-current">
209
205
  </ul>
210
206
  <ul class="current">
211
- <li class="current tsd-kind-interface">
212
- <a href="tcpedge.html" class="tsd-kind-icon">TCPEdge</a>
207
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
208
+ <a href="datatypes.HTTPResponseBackendUpdate.html" class="tsd-kind-icon">HTTPResponse<wbr>Backend<wbr>Update</a>
213
209
  <ul>
214
210
  <li class=" tsd-kind-property tsd-parent-kind-interface">
215
- <a href="tcpedge.html#backend" class="tsd-kind-icon">backend</a>
216
- </li>
217
- <li class=" tsd-kind-property tsd-parent-kind-interface">
218
- <a href="tcpedge.html#created_at" class="tsd-kind-icon">created_<wbr>at</a>
211
+ <a href="datatypes.HTTPResponseBackendUpdate.html#body" class="tsd-kind-icon">body</a>
219
212
  </li>
220
213
  <li class=" tsd-kind-property tsd-parent-kind-interface">
221
- <a href="tcpedge.html#description" class="tsd-kind-icon">description</a>
214
+ <a href="datatypes.HTTPResponseBackendUpdate.html#description" class="tsd-kind-icon">description</a>
222
215
  </li>
223
216
  <li class=" tsd-kind-property tsd-parent-kind-interface">
224
- <a href="tcpedge.html#id" class="tsd-kind-icon">id</a>
217
+ <a href="datatypes.HTTPResponseBackendUpdate.html#headers" class="tsd-kind-icon">headers</a>
225
218
  </li>
226
219
  <li class=" tsd-kind-property tsd-parent-kind-interface">
227
- <a href="tcpedge.html#ip_restriction" class="tsd-kind-icon">ip_<wbr>restriction</a>
220
+ <a href="datatypes.HTTPResponseBackendUpdate.html#id" class="tsd-kind-icon">id</a>
228
221
  </li>
229
222
  <li class=" tsd-kind-property tsd-parent-kind-interface">
230
- <a href="tcpedge.html#metadata" class="tsd-kind-icon">metadata</a>
223
+ <a href="datatypes.HTTPResponseBackendUpdate.html#metadata" class="tsd-kind-icon">metadata</a>
231
224
  </li>
232
225
  <li class=" tsd-kind-property tsd-parent-kind-interface">
233
- <a href="tcpedge.html#uri" class="tsd-kind-icon">uri</a>
226
+ <a href="datatypes.HTTPResponseBackendUpdate.html#statusCode" class="tsd-kind-icon">status<wbr>Code</a>
234
227
  </li>
235
228
  </ul>
236
229
  </li>
@@ -246,11 +239,11 @@
246
239
  <h2>Legend</h2>
247
240
  <div class="tsd-legend-group">
248
241
  <ul class="tsd-legend">
249
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
250
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
242
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
243
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
251
244
  </ul>
252
245
  <ul class="tsd-legend">
253
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
246
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
254
247
  </ul>
255
248
  </div>
256
249
  </div>
package/docs/interfaces/{eventstream.html → datatypes.HTTPSEdge.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>EventStream | @ngrok/ngrok-api</title>
6
+ <title>HTTPSEdge | @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="eventstream.html">EventStream</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.HTTPSEdge.html">HTTPSEdge</a>
59
62
  </li>
60
63
  </ul>
61
- <h1>Interface EventStream</h1>
64
+ <h1>Interface HTTPSEdge</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">EventStream</span>
75
+ <span class="target">HTTPSEdge</span>
73
76
  </li>
74
77
  </ul>
75
78
  </section>
@@ -80,15 +83,15 @@
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="eventstream.html#created_at" class="tsd-kind-icon">created_<wbr>at</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventstream.html#description" class="tsd-kind-icon">description</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventstream.html#destination_ids" class="tsd-kind-icon">destination_<wbr>ids</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventstream.html#event_type" class="tsd-kind-icon">event_<wbr>type</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventstream.html#fields" class="tsd-kind-icon">fields</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventstream.html#id" class="tsd-kind-icon">id</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventstream.html#metadata" class="tsd-kind-icon">metadata</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventstream.html#sampling_rate" class="tsd-kind-icon">sampling_<wbr>rate</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventstream.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#hostports" class="tsd-kind-icon">hostports</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#id" class="tsd-kind-icon">id</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#metadata" class="tsd-kind-icon">metadata</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#routes" class="tsd-kind-icon">routes</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdge.html#uri" class="tsd-kind-icon">uri</a></li>
92
95
  </ul>
93
96
  </section>
94
97
  </div>
@@ -97,17 +100,17 @@
97
100
  <section class="tsd-panel-group tsd-member-group ">
98
101
  <h2>Properties</h2>
99
102
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
100
- <a name="created_at" class="tsd-anchor"></a>
101
- <h3>created_<wbr>at</h3>
102
- <div class="tsd-signature tsd-kind-icon">created_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
103
+ <a name="createdAt" class="tsd-anchor"></a>
104
+ <h3>created<wbr>At</h3>
105
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
103
106
  <aside class="tsd-sources">
104
107
  <ul>
105
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L866">types.ts:866</a></li>
108
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L853">datatypes.ts:853</a></li>
106
109
  </ul>
107
110
  </aside>
108
111
  <div class="tsd-comment tsd-typography">
109
112
  <div class="lead">
110
- <p>Timestamp when the Event Stream was created, RFC 3339 format.</p>
113
+ <p>timestamp when the edge configuration was created, RFC 3339 format</p>
111
114
  </div>
112
115
  </div>
113
116
  </section>
@@ -117,104 +120,99 @@
117
120
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
118
121
  <aside class="tsd-sources">
119
122
  <ul>
120
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L870">types.ts:870</a></li>
123
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L849">datatypes.ts:849</a></li>
121
124
  </ul>
122
125
  </aside>
123
126
  <div class="tsd-comment tsd-typography">
124
127
  <div class="lead">
125
- <p>Human-readable description of the Event Stream. Optional, max 255 bytes.</p>
128
+ <p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
126
129
  </div>
127
130
  </div>
128
131
  </section>
129
132
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
130
- <a name="destination_ids" class="tsd-anchor"></a>
131
- <h3>destination_<wbr>ids</h3>
132
- <div class="tsd-signature tsd-kind-icon">destination_<wbr>ids<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
133
+ <a name="hostports" class="tsd-anchor"></a>
134
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> hostports</h3>
135
+ <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>
133
136
  <aside class="tsd-sources">
134
137
  <ul>
135
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L876">types.ts:876</a></li>
138
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L857">datatypes.ts:857</a></li>
136
139
  </ul>
137
140
  </aside>
138
141
  <div class="tsd-comment tsd-typography">
139
142
  <div class="lead">
140
- <p>A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</p>
143
+ <p>hostports served by this edge</p>
141
144
  </div>
142
145
  </div>
143
146
  </section>
144
147
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
145
- <a name="event_type" class="tsd-anchor"></a>
146
- <h3>event_<wbr>type</h3>
147
- <div class="tsd-signature tsd-kind-icon">event_<wbr>type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
148
+ <a name="id" class="tsd-anchor"></a>
149
+ <h3>id</h3>
150
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
148
151
  <aside class="tsd-sources">
149
152
  <ul>
150
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L874">types.ts:874</a></li>
153
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L847">datatypes.ts:847</a></li>
151
154
  </ul>
152
155
  </aside>
153
156
  <div class="tsd-comment tsd-typography">
154
157
  <div class="lead">
155
- <p>The protocol that determines which events will be collected. Supported values are tcp_connection_closed and http_request_complete.</p>
158
+ <p>unique identifier of this edge</p>
156
159
  </div>
157
160
  </div>
158
161
  </section>
159
162
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
160
- <a name="fields" class="tsd-anchor"></a>
161
- <h3>fields</h3>
162
- <div class="tsd-signature tsd-kind-icon">fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
163
+ <a name="metadata" class="tsd-anchor"></a>
164
+ <h3>metadata</h3>
165
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
163
166
  <aside class="tsd-sources">
164
167
  <ul>
165
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L872">types.ts:872</a></li>
168
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L851">datatypes.ts:851</a></li>
166
169
  </ul>
167
170
  </aside>
168
171
  <div class="tsd-comment tsd-typography">
169
172
  <div class="lead">
170
- <p>A list of protocol-specific fields you want to collect on each event.</p>
173
+ <p>arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.</p>
171
174
  </div>
172
175
  </div>
173
176
  </section>
174
177
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
175
- <a name="id" class="tsd-anchor"></a>
176
- <h3>id</h3>
177
- <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
178
+ <a name="mutualTls" class="tsd-anchor"></a>
179
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> mutual<wbr>Tls</h3>
180
+ <div class="tsd-signature tsd-kind-icon">mutual<wbr>Tls<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointMutualTLS.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLS</a></div>
178
181
  <aside class="tsd-sources">
179
182
  <ul>
180
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L862">types.ts:862</a></li>
183
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L859">datatypes.ts:859</a></li>
181
184
  </ul>
182
185
  </aside>
183
186
  <div class="tsd-comment tsd-typography">
184
187
  <div class="lead">
185
- <p>Unique identifier for this Event Stream.</p>
188
+ <p>edge modules</p>
186
189
  </div>
187
190
  </div>
188
191
  </section>
189
192
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
190
- <a name="metadata" class="tsd-anchor"></a>
191
- <h3>metadata</h3>
192
- <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
193
+ <a name="routes" class="tsd-anchor"></a>
194
+ <h3>routes</h3>
195
+ <div class="tsd-signature tsd-kind-icon">routes<span class="tsd-signature-symbol">:</span> <a href="datatypes.HTTPSEdgeRoute.html" class="tsd-signature-type" data-tsd-kind="Interface">HTTPSEdgeRoute</a><span class="tsd-signature-symbol">[]</span></div>
193
196
  <aside class="tsd-sources">
194
197
  <ul>
195
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L868">types.ts:868</a></li>
198
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L862">datatypes.ts:862</a></li>
196
199
  </ul>
197
200
  </aside>
198
201
  <div class="tsd-comment tsd-typography">
199
202
  <div class="lead">
200
- <p>Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.</p>
203
+ <p>routes</p>
201
204
  </div>
202
205
  </div>
203
206
  </section>
204
207
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
205
- <a name="sampling_rate" class="tsd-anchor"></a>
206
- <h3>sampling_<wbr>rate</h3>
207
- <div class="tsd-signature tsd-kind-icon">sampling_<wbr>rate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
208
+ <a name="tlsTermination" class="tsd-anchor"></a>
209
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> tls<wbr>Termination</h3>
210
+ <div class="tsd-signature tsd-kind-icon">tls<wbr>Termination<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</a></div>
208
211
  <aside class="tsd-sources">
209
212
  <ul>
210
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L878">types.ts:878</a></li>
213
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L860">datatypes.ts:860</a></li>
211
214
  </ul>
212
215
  </aside>
213
- <div class="tsd-comment tsd-typography">
214
- <div class="lead">
215
- <p>The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p>
216
- </div>
217
- </div>
218
216
  </section>
219
217
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
220
218
  <a name="uri" class="tsd-anchor"></a>
@@ -222,12 +220,12 @@
222
220
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
223
221
  <aside class="tsd-sources">
224
222
  <ul>
225
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L864">types.ts:864</a></li>
223
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L855">datatypes.ts:855</a></li>
226
224
  </ul>
227
225
  </aside>
228
226
  <div class="tsd-comment tsd-typography">
229
227
  <div class="lead">
230
- <p>URI of the Event Stream API resource.</p>
228
+ <p>URI of the edge API resource</p>
231
229
  </div>
232
230
  </div>
233
231
  </section>
@@ -237,7 +235,16 @@
237
235
  <nav class="tsd-navigation primary">
238
236
  <ul>
239
237
  <li class=" ">
240
- <a href="../modules.html">Exports</a>
238
+ <a href="../modules.html">Modules</a>
239
+ </li>
240
+ <li class=" tsd-kind-module">
241
+ <a href="../modules/client.html">client</a>
242
+ </li>
243
+ <li class="current tsd-kind-module">
244
+ <a href="../modules/datatypes.html">datatypes</a>
245
+ </li>
246
+ <li class=" tsd-kind-module">
247
+ <a href="../modules/services.html">services</a>
241
248
  </li>
242
249
  </ul>
243
250
  </nav>
@@ -245,35 +252,35 @@
245
252
  <ul class="before-current">
246
253
  </ul>
247
254
  <ul class="current">
248
- <li class="current tsd-kind-interface">
249
- <a href="eventstream.html" class="tsd-kind-icon">Event<wbr>Stream</a>
255
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
256
+ <a href="datatypes.HTTPSEdge.html" class="tsd-kind-icon">HTTPSEdge</a>
250
257
  <ul>
251
258
  <li class=" tsd-kind-property tsd-parent-kind-interface">
252
- <a href="eventstream.html#created_at" class="tsd-kind-icon">created_<wbr>at</a>
259
+ <a href="datatypes.HTTPSEdge.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
253
260
  </li>
254
261
  <li class=" tsd-kind-property tsd-parent-kind-interface">
255
- <a href="eventstream.html#description" class="tsd-kind-icon">description</a>
262
+ <a href="datatypes.HTTPSEdge.html#description" class="tsd-kind-icon">description</a>
256
263
  </li>
257
264
  <li class=" tsd-kind-property tsd-parent-kind-interface">
258
- <a href="eventstream.html#destination_ids" class="tsd-kind-icon">destination_<wbr>ids</a>
265
+ <a href="datatypes.HTTPSEdge.html#hostports" class="tsd-kind-icon">hostports</a>
259
266
  </li>
260
267
  <li class=" tsd-kind-property tsd-parent-kind-interface">
261
- <a href="eventstream.html#event_type" class="tsd-kind-icon">event_<wbr>type</a>
268
+ <a href="datatypes.HTTPSEdge.html#id" class="tsd-kind-icon">id</a>
262
269
  </li>
263
270
  <li class=" tsd-kind-property tsd-parent-kind-interface">
264
- <a href="eventstream.html#fields" class="tsd-kind-icon">fields</a>
271
+ <a href="datatypes.HTTPSEdge.html#metadata" class="tsd-kind-icon">metadata</a>
265
272
  </li>
266
273
  <li class=" tsd-kind-property tsd-parent-kind-interface">
267
- <a href="eventstream.html#id" class="tsd-kind-icon">id</a>
274
+ <a href="datatypes.HTTPSEdge.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a>
268
275
  </li>
269
276
  <li class=" tsd-kind-property tsd-parent-kind-interface">
270
- <a href="eventstream.html#metadata" class="tsd-kind-icon">metadata</a>
277
+ <a href="datatypes.HTTPSEdge.html#routes" class="tsd-kind-icon">routes</a>
271
278
  </li>
272
279
  <li class=" tsd-kind-property tsd-parent-kind-interface">
273
- <a href="eventstream.html#sampling_rate" class="tsd-kind-icon">sampling_<wbr>rate</a>
280
+ <a href="datatypes.HTTPSEdge.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a>
274
281
  </li>
275
282
  <li class=" tsd-kind-property tsd-parent-kind-interface">
276
- <a href="eventstream.html#uri" class="tsd-kind-icon">uri</a>
283
+ <a href="datatypes.HTTPSEdge.html#uri" class="tsd-kind-icon">uri</a>
277
284
  </li>
278
285
  </ul>
279
286
  </li>
@@ -289,11 +296,11 @@
289
296
  <h2>Legend</h2>
290
297
  <div class="tsd-legend-group">
291
298
  <ul class="tsd-legend">
292
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
293
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
299
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
300
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
294
301
  </ul>
295
302
  <ul class="tsd-legend">
296
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
303
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
297
304
  </ul>
298
305
  </div>
299
306
  </div>