@ngrok/ngrok-api 0.1.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (283) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +102 -31
  3. package/docs/CNAME +1 -0
  4. package/docs/assets/js/search.js +1 -1
  5. package/docs/classes/client.Ngrok.html +772 -0
  6. package/docs/classes/services.APIKeys.html +354 -0
  7. package/docs/classes/services.AbuseReports.html +261 -0
  8. package/docs/classes/services.AgentIngresses.html +343 -0
  9. package/docs/classes/services.CertificateAuthorities.html +354 -0
  10. package/docs/classes/services.Credentials.html +353 -0
  11. package/docs/classes/services.EdgeRouteBackendModule.html +270 -0
  12. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +270 -0
  13. package/docs/classes/services.EdgeRouteCompressionModule.html +270 -0
  14. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +270 -0
  15. package/docs/classes/services.EdgeRouteOAuthModule.html +270 -0
  16. package/docs/classes/services.EdgeRouteOIDCModule.html +270 -0
  17. package/docs/classes/services.EdgeRouteRequestHeadersModule.html +270 -0
  18. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +270 -0
  19. package/docs/classes/services.EdgeRouteSAMLModule.html +270 -0
  20. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +270 -0
  21. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +270 -0
  22. package/docs/classes/services.EdgesHTTPS.html +343 -0
  23. package/docs/classes/services.EdgesHTTPSRoutes.html +317 -0
  24. package/docs/classes/services.EdgesTCP.html +343 -0
  25. package/docs/classes/services.EdgesTLS.html +343 -0
  26. package/docs/classes/services.Endpoints.html +256 -0
  27. package/docs/classes/services.EventDestinations.html +343 -0
  28. package/docs/classes/services.EventSources.html +349 -0
  29. package/docs/classes/services.EventSubscriptions.html +343 -0
  30. package/docs/classes/services.FailoverBackends.html +353 -0
  31. package/docs/classes/services.HTTPResponseBackends.html +318 -0
  32. package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +270 -0
  33. package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +270 -0
  34. package/docs/classes/services.IPPolicies.html +353 -0
  35. package/docs/classes/services.IPPolicyRules.html +351 -0
  36. package/docs/classes/services.IPRestrictions.html +355 -0
  37. package/docs/classes/services.ReservedAddrs.html +352 -0
  38. package/docs/classes/services.ReservedDomains.html +417 -0
  39. package/docs/classes/services.SSHCertificateAuthorities.html +351 -0
  40. package/docs/classes/services.SSHCredentials.html +351 -0
  41. package/docs/classes/services.SSHHostCertificates.html +352 -0
  42. package/docs/classes/services.SSHUserCertificates.html +352 -0
  43. package/docs/classes/services.TCPEdgeBackendModule.html +270 -0
  44. package/docs/classes/services.TCPEdgeIPRestrictionModule.html +270 -0
  45. package/docs/classes/services.TLSCertificates.html +354 -0
  46. package/docs/classes/services.TLSEdgeBackendModule.html +270 -0
  47. package/docs/classes/services.TLSEdgeIPRestrictionModule.html +270 -0
  48. package/docs/classes/services.TLSEdgeMutualTLSModule.html +270 -0
  49. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +270 -0
  50. package/docs/classes/services.TunnelGroupBackends.html +351 -0
  51. package/docs/classes/services.TunnelSessions.html +352 -0
  52. package/docs/classes/services.Tunnels.html +255 -0
  53. package/docs/classes/services.WeightedBackends.html +353 -0
  54. package/docs/index.html +103 -546
  55. package/docs/interfaces/client.NgrokConfig.html +179 -0
  56. package/docs/interfaces/{apikey.html → datatypes.APIKey.html} +41 -29
  57. package/docs/interfaces/{apikeycreate.html → datatypes.APIKeyCreate.html} +25 -13
  58. package/docs/interfaces/{apikeylist.html → datatypes.APIKeyList.html} +32 -20
  59. package/docs/interfaces/{apikeyupdate.html → datatypes.APIKeyUpdate.html} +28 -16
  60. package/docs/interfaces/{awsauth.html → datatypes.AWSAuth.html} +27 -15
  61. package/docs/interfaces/{awscredentials.html → datatypes.AWSCredentials.html} +31 -19
  62. package/docs/interfaces/{awsrole.html → datatypes.AWSRole.html} +25 -13
  63. package/docs/interfaces/{abusereport.html → datatypes.AbuseReport.html} +45 -33
  64. package/docs/interfaces/{abusereportcreate.html → datatypes.AbuseReportCreate.html} +25 -13
  65. package/docs/interfaces/{abusereporthostname.html → datatypes.AbuseReportHostname.html} +26 -14
  66. package/docs/interfaces/datatypes.AgentIngress.html +300 -0
  67. package/docs/interfaces/{ipwhitelistentrycreate.html → datatypes.AgentIngressCreate.html} +37 -25
  68. package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
  69. package/docs/interfaces/{ipwhitelistentryupdate.html → datatypes.AgentIngressUpdate.html} +33 -21
  70. package/docs/interfaces/{certificateauthority.html → datatypes.CertificateAuthority.html} +73 -61
  71. package/docs/interfaces/{certificateauthoritycreate.html → datatypes.CertificateAuthorityCreate.html} +31 -19
  72. package/docs/interfaces/{certificateauthoritylist.html → datatypes.CertificateAuthorityList.html} +34 -22
  73. package/docs/interfaces/{certificateauthorityupdate.html → datatypes.CertificateAuthorityUpdate.html} +28 -16
  74. package/docs/interfaces/{credential.html → datatypes.Credential.html} +45 -33
  75. package/docs/interfaces/{credentialcreate.html → datatypes.CredentialCreate.html} +29 -17
  76. package/docs/interfaces/{credentiallist.html → datatypes.CredentialList.html} +32 -20
  77. package/docs/interfaces/{credentialupdate.html → datatypes.CredentialUpdate.html} +32 -20
  78. package/docs/interfaces/{endpointippolicyreplace.html → datatypes.EdgeBackendReplace.html} +29 -17
  79. package/docs/interfaces/{endpointbackendreplace.html → datatypes.EdgeIPRestrictionReplace.html} +29 -17
  80. package/docs/interfaces/{endpointresponseheadersreplace.html → datatypes.EdgeMutualTLSReplace.html} +29 -17
  81. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +190 -0
  82. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +190 -0
  83. package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +190 -0
  84. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +190 -0
  85. package/docs/interfaces/{reserveddomaincertnstarget.html → datatypes.EdgeRouteItem.html} +36 -24
  86. package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +190 -0
  87. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +190 -0
  88. package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +190 -0
  89. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +190 -0
  90. package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +190 -0
  91. package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +190 -0
  92. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +190 -0
  93. package/docs/interfaces/{endpointoauthreplace.html → datatypes.EdgeTLSTerminationAtEdgeReplace.html} +29 -17
  94. package/docs/interfaces/{endpointbasicauthreplace.html → datatypes.EdgeTLSTerminationReplace.html} +29 -17
  95. package/docs/interfaces/{empty.html → datatypes.Empty.html} +18 -7
  96. package/docs/interfaces/datatypes.Endpoint.html +395 -0
  97. package/docs/interfaces/{endpointbackend.html → datatypes.EndpointBackend.html} +27 -15
  98. package/docs/interfaces/{endpointlogging.html → datatypes.EndpointBackendMutate.html} +36 -24
  99. package/docs/interfaces/{endpointcircuitbreaker.html → datatypes.EndpointCircuitBreaker.html} +53 -41
  100. package/docs/interfaces/{endpointcompression.html → datatypes.EndpointCompression.html} +23 -11
  101. package/docs/interfaces/{endpointippolicy.html → datatypes.EndpointIPPolicy.html} +29 -17
  102. package/docs/interfaces/{endpointippolicymutate.html → datatypes.EndpointIPPolicyMutate.html} +29 -17
  103. package/docs/interfaces/datatypes.EndpointList.html +205 -0
  104. package/docs/interfaces/{endpointmutualtls.html → datatypes.EndpointMutualTLS.html} +29 -17
  105. package/docs/interfaces/{endpointmutualtlsmutate.html → datatypes.EndpointMutualTLSMutate.html} +29 -17
  106. package/docs/interfaces/{endpointoauth.html → datatypes.EndpointOAuth.html} +57 -45
  107. package/docs/interfaces/{endpointoauthfacebook.html → datatypes.EndpointOAuthFacebook.html} +48 -36
  108. package/docs/interfaces/{endpointoauthgithub.html → datatypes.EndpointOAuthGitHub.html} +55 -43
  109. package/docs/interfaces/{endpointoauthgoogle.html → datatypes.EndpointOAuthGoogle.html} +48 -36
  110. package/docs/interfaces/{endpointoauthmicrosoft.html → datatypes.EndpointOAuthMicrosoft.html} +48 -36
  111. package/docs/interfaces/{endpointoauthprovider.html → datatypes.EndpointOAuthProvider.html} +35 -23
  112. package/docs/interfaces/{endpointoidc.html → datatypes.EndpointOIDC.html} +65 -53
  113. package/docs/interfaces/{endpointrequestheaders.html → datatypes.EndpointRequestHeaders.html} +29 -17
  114. package/docs/interfaces/{endpointresponseheaders.html → datatypes.EndpointResponseHeaders.html} +29 -17
  115. package/docs/interfaces/{endpointsaml.html → datatypes.EndpointSAML.html} +121 -90
  116. package/docs/interfaces/{endpointsamlmutate.html → datatypes.EndpointSAMLMutate.html} +91 -60
  117. package/docs/interfaces/{endpointtlstermination.html → datatypes.EndpointTLSTermination.html} +37 -25
  118. package/docs/interfaces/{endpointloggingmutate.html → datatypes.EndpointTLSTerminationAtEdge.html} +33 -21
  119. package/docs/interfaces/{endpointwebhookvalidation.html → datatypes.EndpointWebhookValidation.html} +30 -18
  120. package/docs/interfaces/{staticbackendtls.html → datatypes.EndpointWebsocketTCPConverter.html} +27 -15
  121. package/docs/interfaces/{error.html → datatypes.Error.html} +37 -25
  122. package/docs/interfaces/{eventdestination.html → datatypes.EventDestination.html} +46 -34
  123. package/docs/interfaces/{eventdestinationcreate.html → datatypes.EventDestinationCreate.html} +34 -22
  124. package/docs/interfaces/{eventdestinationlist.html → datatypes.EventDestinationList.html} +34 -22
  125. package/docs/interfaces/{eventdestinationupdate.html → datatypes.EventDestinationUpdate.html} +37 -25
  126. package/docs/interfaces/{eventsource.html → datatypes.EventSource.html} +25 -13
  127. package/docs/interfaces/{eventsourcecreate.html → datatypes.EventSourceCreate.html} +28 -16
  128. package/docs/interfaces/{eventsourceitem.html → datatypes.EventSourceItem.html} +28 -16
  129. package/docs/interfaces/{eventsourcelist.html → datatypes.EventSourceList.html} +26 -14
  130. package/docs/interfaces/{eventsourcepaging.html → datatypes.EventSourcePaging.html} +25 -13
  131. package/docs/interfaces/{eventsourcereplace.html → datatypes.EventSourceReplace.html} +22 -10
  132. package/docs/interfaces/{eventsourceupdate.html → datatypes.EventSourceUpdate.html} +28 -16
  133. package/docs/interfaces/{eventsubscription.html → datatypes.EventSubscription.html} +45 -33
  134. package/docs/interfaces/{eventsubscriptioncreate.html → datatypes.EventSubscriptionCreate.html} +36 -24
  135. package/docs/interfaces/{eventsubscriptionlist.html → datatypes.EventSubscriptionList.html} +34 -22
  136. package/docs/interfaces/{eventsubscriptionupdate.html → datatypes.EventSubscriptionUpdate.html} +39 -27
  137. package/docs/interfaces/{eventtarget.html → datatypes.EventTarget.html} +33 -21
  138. package/docs/interfaces/{eventtargetcloudwatchlogs.html → datatypes.EventTargetCloudwatchLogs.html} +30 -18
  139. package/docs/interfaces/{eventtargetfirehose.html → datatypes.EventTargetFirehose.html} +30 -18
  140. package/docs/interfaces/{eventtargetkinesis.html → datatypes.EventTargetKinesis.html} +30 -18
  141. package/docs/interfaces/{staticbackend.html → datatypes.FailoverBackend.html} +52 -40
  142. package/docs/interfaces/{prioritybackendcreate.html → datatypes.FailoverBackendCreate.html} +31 -19
  143. package/docs/interfaces/{prioritybackendlist.html → datatypes.FailoverBackendList.html} +37 -25
  144. package/docs/interfaces/{prioritybackendupdate.html → datatypes.FailoverBackendUpdate.html} +34 -22
  145. package/docs/interfaces/datatypes.HTTPResponseBackend.html +295 -0
  146. package/docs/interfaces/{tunnelgroupbackend.html → datatypes.HTTPResponseBackendCreate.html} +53 -41
  147. package/docs/interfaces/{staticbackendlist.html → datatypes.HTTPResponseBackendList.html} +35 -38
  148. package/docs/interfaces/{tcpedge.html → datatypes.HTTPResponseBackendUpdate.html} +58 -65
  149. package/docs/interfaces/{eventstream.html → datatypes.HTTPSEdge.html} +78 -71
  150. package/docs/interfaces/{staticbackendupdate.html → datatypes.HTTPSEdgeCreate.html} +60 -48
  151. package/docs/interfaces/datatypes.HTTPSEdgeList.html +205 -0
  152. package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +509 -0
  153. package/docs/interfaces/{endpointconfigurationcreate.html → datatypes.HTTPSEdgeRouteCreate.html} +141 -110
  154. package/docs/interfaces/{endpointconfiguration.html → datatypes.HTTPSEdgeRouteUpdate.html} +138 -145
  155. package/docs/interfaces/{tlsedgeupdate.html → datatypes.HTTPSEdgeUpdate.html} +65 -43
  156. package/docs/interfaces/{ippolicy.html → datatypes.IPPolicy.html} +37 -44
  157. package/docs/interfaces/{ippolicycreate.html → datatypes.IPPolicyCreate.html} +25 -32
  158. package/docs/interfaces/{ippolicylist.html → datatypes.IPPolicyList.html} +34 -22
  159. package/docs/interfaces/{ippolicyrule.html → datatypes.IPPolicyRule.html} +65 -34
  160. package/docs/interfaces/{ippolicyrulecreate.html → datatypes.IPPolicyRuleCreate.html} +53 -22
  161. package/docs/interfaces/{ippolicyrulelist.html → datatypes.IPPolicyRuleList.html} +34 -22
  162. package/docs/interfaces/{ippolicyruleupdate.html → datatypes.IPPolicyRuleUpdate.html} +31 -19
  163. package/docs/interfaces/{ippolicyupdate.html → datatypes.IPPolicyUpdate.html} +28 -16
  164. package/docs/interfaces/{iprestriction.html → datatypes.IPRestriction.html} +50 -38
  165. package/docs/interfaces/{iprestrictioncreate.html → datatypes.IPRestrictionCreate.html} +38 -26
  166. package/docs/interfaces/{iprestrictionlist.html → datatypes.IPRestrictionList.html} +34 -22
  167. package/docs/interfaces/{iprestrictionupdate.html → datatypes.IPRestrictionUpdate.html} +37 -25
  168. package/docs/interfaces/{item.html → datatypes.Item.html} +22 -10
  169. package/docs/interfaces/{paging.html → datatypes.Paging.html} +28 -16
  170. package/docs/interfaces/{ref.html → datatypes.Ref.html} +25 -13
  171. package/docs/interfaces/{reservedaddr.html → datatypes.ReservedAddr.html} +43 -50
  172. package/docs/interfaces/{reservedaddrcreate.html → datatypes.ReservedAddrCreate.html} +28 -35
  173. package/docs/interfaces/{reservedaddrlist.html → datatypes.ReservedAddrList.html} +34 -22
  174. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +200 -0
  175. package/docs/interfaces/{reserveddomain.html → datatypes.ReservedDomain.html} +82 -89
  176. package/docs/interfaces/{reserveddomaincertjob.html → datatypes.ReservedDomainCertJob.html} +40 -47
  177. package/docs/interfaces/{reserveddomaincertpolicy.html → datatypes.ReservedDomainCertPolicy.html} +28 -16
  178. package/docs/interfaces/{reserveddomaincertstatus.html → datatypes.ReservedDomainCertStatus.html} +31 -19
  179. package/docs/interfaces/{reserveddomaincreate.html → datatypes.ReservedDomainCreate.html} +45 -71
  180. package/docs/interfaces/{reserveddomainlist.html → datatypes.ReservedDomainList.html} +34 -22
  181. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +238 -0
  182. package/docs/interfaces/{sshcertificateauthority.html → datatypes.SSHCertificateAuthority.html} +49 -37
  183. package/docs/interfaces/{sshcertificateauthoritycreate.html → datatypes.SSHCertificateAuthorityCreate.html} +45 -33
  184. package/docs/interfaces/{sshcertificateauthoritylist.html → datatypes.SSHCertificateAuthorityList.html} +34 -22
  185. package/docs/interfaces/{sshcertificateauthorityupdate.html → datatypes.SSHCertificateAuthorityUpdate.html} +28 -16
  186. package/docs/interfaces/{sshcredential.html → datatypes.SSHCredential.html} +47 -35
  187. package/docs/interfaces/{sshcredentialcreate.html → datatypes.SSHCredentialCreate.html} +35 -23
  188. package/docs/interfaces/{sshcredentiallist.html → datatypes.SSHCredentialList.html} +34 -22
  189. package/docs/interfaces/{sshcredentialupdate.html → datatypes.SSHCredentialUpdate.html} +32 -20
  190. package/docs/interfaces/{sshhostcertificate.html → datatypes.SSHHostCertificate.html} +76 -64
  191. package/docs/interfaces/{sshhostcertificatecreate.html → datatypes.SSHHostCertificateCreate.html} +53 -41
  192. package/docs/interfaces/{sshhostcertificatelist.html → datatypes.SSHHostCertificateList.html} +34 -22
  193. package/docs/interfaces/{sshhostcertificateupdate.html → datatypes.SSHHostCertificateUpdate.html} +28 -16
  194. package/docs/interfaces/{sshusercertificate.html → datatypes.SSHUserCertificate.html} +87 -75
  195. package/docs/interfaces/{sshusercertificatecreate.html → datatypes.SSHUserCertificateCreate.html} +64 -52
  196. package/docs/interfaces/{sshusercertificatelist.html → datatypes.SSHUserCertificateList.html} +34 -22
  197. package/docs/interfaces/{sshusercertificateupdate.html → datatypes.SSHUserCertificateUpdate.html} +28 -16
  198. package/docs/interfaces/{tlsedge.html → datatypes.TCPEdge.html} +69 -66
  199. package/docs/interfaces/{tlsedgecreate.html → datatypes.TCPEdgeCreate.html} +64 -42
  200. package/docs/interfaces/{endpointconfigurationlist.html → datatypes.TCPEdgeList.html} +40 -28
  201. package/docs/interfaces/{eventstreamupdate.html → datatypes.TCPEdgeUpdate.html} +60 -53
  202. package/docs/interfaces/{tlscertificate.html → datatypes.TLSCertificate.html} +134 -122
  203. package/docs/interfaces/{tlscertificatecreate.html → datatypes.TLSCertificateCreate.html} +39 -27
  204. package/docs/interfaces/{tlscertificatelist.html → datatypes.TLSCertificateList.html} +34 -22
  205. package/docs/interfaces/{tlscertificatesans.html → datatypes.TLSCertificateSANs.html} +28 -16
  206. package/docs/interfaces/{tlscertificateupdate.html → datatypes.TLSCertificateUpdate.html} +28 -16
  207. package/docs/interfaces/datatypes.TLSEdge.html +323 -0
  208. package/docs/interfaces/datatypes.TLSEdgeCreate.html +266 -0
  209. package/docs/interfaces/datatypes.TLSEdgeList.html +205 -0
  210. package/docs/interfaces/{reserveddomainupdate.html → datatypes.TLSEdgeUpdate.html} +83 -62
  211. package/docs/interfaces/datatypes.Tunnel.html +357 -0
  212. package/docs/interfaces/datatypes.TunnelGroupBackend.html +281 -0
  213. package/docs/interfaces/{tunnelgroupbackendcreate.html → datatypes.TunnelGroupBackendCreate.html} +28 -16
  214. package/docs/interfaces/{tunnelgroupbackendlist.html → datatypes.TunnelGroupBackendList.html} +32 -20
  215. package/docs/interfaces/{tunnelgroupbackendupdate.html → datatypes.TunnelGroupBackendUpdate.html} +31 -19
  216. package/docs/interfaces/{tunnellist.html → datatypes.TunnelList.html} +32 -20
  217. package/docs/interfaces/{tunnelsession.html → datatypes.TunnelSession.html} +57 -45
  218. package/docs/interfaces/{tunnelsessionlist.html → datatypes.TunnelSessionList.html} +34 -22
  219. package/docs/interfaces/{tunnelsessionsupdate.html → datatypes.TunnelSessionsUpdate.html} +22 -10
  220. package/docs/interfaces/{weightedbackend.html → datatypes.WeightedBackend.html} +56 -25
  221. package/docs/interfaces/{weightedbackendcreate.html → datatypes.WeightedBackendCreate.html} +28 -16
  222. package/docs/interfaces/{weightedbackendlist.html → datatypes.WeightedBackendList.html} +32 -20
  223. package/docs/interfaces/{weightedbackendupdate.html → datatypes.WeightedBackendUpdate.html} +31 -19
  224. package/docs/{interfaces/endpointbasicauth.html → modules/client.html} +38 -20
  225. package/docs/modules/datatypes.html +796 -0
  226. package/docs/modules/services.html +316 -0
  227. package/docs/modules.html +16 -690
  228. package/lib/client.d.ts +179 -0
  229. package/lib/client.d.ts.map +1 -0
  230. package/lib/client.js +126 -0
  231. package/lib/client.js.map +1 -0
  232. package/lib/{types.d.ts → datatypes.d.ts} +729 -660
  233. package/lib/datatypes.d.ts.map +1 -0
  234. package/lib/{types.js → datatypes.js} +1 -1
  235. package/lib/datatypes.js.map +1 -0
  236. package/lib/index.d.ts +2 -378
  237. package/lib/index.d.ts.map +1 -1
  238. package/lib/index.js +2 -2148
  239. package/lib/index.js.map +1 -1
  240. package/lib/services.d.ts +993 -0
  241. package/lib/services.d.ts.map +1 -0
  242. package/lib/services.js +3600 -0
  243. package/lib/services.js.map +1 -0
  244. package/lib/util.d.ts +5 -0
  245. package/lib/util.d.ts.map +1 -0
  246. package/lib/util.js +53 -0
  247. package/lib/util.js.map +1 -0
  248. package/package.json +2 -2
  249. package/src/client.ts +322 -0
  250. package/src/{types.ts → datatypes.ts} +760 -689
  251. package/src/index.ts +2 -1775
  252. package/src/services.ts +3380 -0
  253. package/src/util.ts +48 -0
  254. package/test/apikey.test.js +41 -30
  255. package/docs/classes/ngrok.html +0 -5028
  256. package/docs/interfaces/endpointbackendmutate.html +0 -119
  257. package/docs/interfaces/endpointcircuitbreakerreplace.html +0 -164
  258. package/docs/interfaces/endpointcompressionreplace.html +0 -164
  259. package/docs/interfaces/endpointconfigurationupdate.html +0 -421
  260. package/docs/interfaces/endpointloggingreplace.html +0 -164
  261. package/docs/interfaces/endpointmutualtlsreplace.html +0 -164
  262. package/docs/interfaces/endpointoidcreplace.html +0 -164
  263. package/docs/interfaces/endpointrequestheadersreplace.html +0 -164
  264. package/docs/interfaces/endpointsamlreplace.html +0 -164
  265. package/docs/interfaces/endpointtlsterminationreplace.html +0 -164
  266. package/docs/interfaces/endpointwebhookvalidationreplace.html +0 -164
  267. package/docs/interfaces/eventstreamcreate.html +0 -250
  268. package/docs/interfaces/eventstreamlist.html +0 -193
  269. package/docs/interfaces/eventtargetdebug.html +0 -119
  270. package/docs/interfaces/eventtargets3.html +0 -250
  271. package/docs/interfaces/ipwhitelistentry.html +0 -250
  272. package/docs/interfaces/ipwhitelistentrylist.html +0 -193
  273. package/docs/interfaces/prioritybackend.html +0 -231
  274. package/docs/interfaces/reservedaddrupdate.html +0 -207
  275. package/docs/interfaces/rootresponse.html +0 -164
  276. package/docs/interfaces/sentevent.html +0 -150
  277. package/docs/interfaces/staticbackendcreate.html +0 -212
  278. package/docs/interfaces/tcpedgecreate.html +0 -188
  279. package/docs/interfaces/tcpedgeupdate.html +0 -207
  280. package/docs/interfaces/tunnel.html +0 -269
  281. package/lib/types.d.ts.map +0 -1
  282. package/lib/types.js.map +0 -1
  283. package/test/endpointConfigurations.test.js +0 -63
package/docs/interfaces/datatypes.Endpoint.html ADDED
@@ -0,0 +1,395 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>Endpoint | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.Endpoint.html">Endpoint</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface Endpoint</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">Endpoint</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#domain" class="tsd-kind-icon">domain</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#edge" class="tsd-kind-icon">edge</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#hostport" class="tsd-kind-icon">hostport</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#id" class="tsd-kind-icon">id</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#metadata" class="tsd-kind-icon">metadata</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#proto" class="tsd-kind-icon">proto</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#publicUrl" class="tsd-kind-icon">public<wbr>Url</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#region" class="tsd-kind-icon">region</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#tcpAddr" class="tsd-kind-icon">tcp<wbr>Addr</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#tunnel" class="tsd-kind-icon">tunnel</a></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#type" class="tsd-kind-icon">type</a></li>
98
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Endpoint.html#updatedAt" class="tsd-kind-icon">updated<wbr>At</a></li>
99
+ </ul>
100
+ </section>
101
+ </div>
102
+ </section>
103
+ </section>
104
+ <section class="tsd-panel-group tsd-member-group ">
105
+ <h2>Properties</h2>
106
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
107
+ <a name="createdAt" class="tsd-anchor"></a>
108
+ <h3>created<wbr>At</h3>
109
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
110
+ <aside class="tsd-sources">
111
+ <ul>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1074">datatypes.ts:1074</a></li>
113
+ </ul>
114
+ </aside>
115
+ <div class="tsd-comment tsd-typography">
116
+ <div class="lead">
117
+ <p>timestamp when the endpoint was created in RFC 3339 format</p>
118
+ </div>
119
+ </div>
120
+ </section>
121
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
122
+ <a name="domain" class="tsd-anchor"></a>
123
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> domain</h3>
124
+ <div class="tsd-signature tsd-kind-icon">domain<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
125
+ <aside class="tsd-sources">
126
+ <ul>
127
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1088">datatypes.ts:1088</a></li>
128
+ </ul>
129
+ </aside>
130
+ <div class="tsd-comment tsd-typography">
131
+ <div class="lead">
132
+ <p>the domain reserved for this endpoint</p>
133
+ </div>
134
+ </div>
135
+ </section>
136
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
137
+ <a name="edge" class="tsd-anchor"></a>
138
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> edge</h3>
139
+ <div class="tsd-signature tsd-kind-icon">edge<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
140
+ <aside class="tsd-sources">
141
+ <ul>
142
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1094">datatypes.ts:1094</a></li>
143
+ </ul>
144
+ </aside>
145
+ <div class="tsd-comment tsd-typography">
146
+ <div class="lead">
147
+ <p>the edge serving requests to this endpoint, if this is an edge endpoint</p>
148
+ </div>
149
+ </div>
150
+ </section>
151
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
152
+ <a name="hostport" class="tsd-anchor"></a>
153
+ <h3>hostport</h3>
154
+ <div class="tsd-signature tsd-kind-icon">hostport<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
155
+ <aside class="tsd-sources">
156
+ <ul>
157
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1082">datatypes.ts:1082</a></li>
158
+ </ul>
159
+ </aside>
160
+ <div class="tsd-comment tsd-typography">
161
+ <div class="lead">
162
+ <p>hostport served by this endpoint (hostname:port)</p>
163
+ </div>
164
+ </div>
165
+ </section>
166
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
167
+ <a name="id" class="tsd-anchor"></a>
168
+ <h3>id</h3>
169
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
170
+ <aside class="tsd-sources">
171
+ <ul>
172
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1070">datatypes.ts:1070</a></li>
173
+ </ul>
174
+ </aside>
175
+ <div class="tsd-comment tsd-typography">
176
+ <div class="lead">
177
+ <p>unique endpoint resource identifier</p>
178
+ </div>
179
+ </div>
180
+ </section>
181
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
182
+ <a name="metadata" class="tsd-anchor"></a>
183
+ <h3>metadata</h3>
184
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
185
+ <aside class="tsd-sources">
186
+ <ul>
187
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1086">datatypes.ts:1086</a></li>
188
+ </ul>
189
+ </aside>
190
+ <div class="tsd-comment tsd-typography">
191
+ <div class="lead">
192
+ <p>user-supplied metadata of the associated tunnel or edge object</p>
193
+ </div>
194
+ </div>
195
+ </section>
196
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
197
+ <a name="proto" class="tsd-anchor"></a>
198
+ <h3>proto</h3>
199
+ <div class="tsd-signature tsd-kind-icon">proto<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
200
+ <aside class="tsd-sources">
201
+ <ul>
202
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1080">datatypes.ts:1080</a></li>
203
+ </ul>
204
+ </aside>
205
+ <div class="tsd-comment tsd-typography">
206
+ <div class="lead">
207
+ <p>protocol served by this endpoint. one of <code>http</code>, <code>https</code>, <code>tcp</code>, or <code>tls</code></p>
208
+ </div>
209
+ </div>
210
+ </section>
211
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
212
+ <a name="publicUrl" class="tsd-anchor"></a>
213
+ <h3>public<wbr>Url</h3>
214
+ <div class="tsd-signature tsd-kind-icon">public<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
215
+ <aside class="tsd-sources">
216
+ <ul>
217
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1078">datatypes.ts:1078</a></li>
218
+ </ul>
219
+ </aside>
220
+ <div class="tsd-comment tsd-typography">
221
+ <div class="lead">
222
+ <p>URL of the hostport served by this endpoint</p>
223
+ </div>
224
+ </div>
225
+ </section>
226
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
227
+ <a name="region" class="tsd-anchor"></a>
228
+ <h3>region</h3>
229
+ <div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
230
+ <aside class="tsd-sources">
231
+ <ul>
232
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1072">datatypes.ts:1072</a></li>
233
+ </ul>
234
+ </aside>
235
+ <div class="tsd-comment tsd-typography">
236
+ <div class="lead">
237
+ <p>identifier of the region this endpoint belongs to</p>
238
+ </div>
239
+ </div>
240
+ </section>
241
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
242
+ <a name="tcpAddr" class="tsd-anchor"></a>
243
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> tcp<wbr>Addr</h3>
244
+ <div class="tsd-signature tsd-kind-icon">tcp<wbr>Addr<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
245
+ <aside class="tsd-sources">
246
+ <ul>
247
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1090">datatypes.ts:1090</a></li>
248
+ </ul>
249
+ </aside>
250
+ <div class="tsd-comment tsd-typography">
251
+ <div class="lead">
252
+ <p>the address reserved for this endpoint</p>
253
+ </div>
254
+ </div>
255
+ </section>
256
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
257
+ <a name="tunnel" class="tsd-anchor"></a>
258
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> tunnel</h3>
259
+ <div class="tsd-signature tsd-kind-icon">tunnel<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
260
+ <aside class="tsd-sources">
261
+ <ul>
262
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1092">datatypes.ts:1092</a></li>
263
+ </ul>
264
+ </aside>
265
+ <div class="tsd-comment tsd-typography">
266
+ <div class="lead">
267
+ <p>the tunnel serving requests to this endpoint, if this is an ephemeral endpoint</p>
268
+ </div>
269
+ </div>
270
+ </section>
271
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
272
+ <a name="type" class="tsd-anchor"></a>
273
+ <h3>type</h3>
274
+ <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
275
+ <aside class="tsd-sources">
276
+ <ul>
277
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1084">datatypes.ts:1084</a></li>
278
+ </ul>
279
+ </aside>
280
+ <div class="tsd-comment tsd-typography">
281
+ <div class="lead">
282
+ <p>whether the endpoint is <code>ephemeral</code> (served directly by an agent-initiated tunnel) or <code>edge</code> (served by an edge)</p>
283
+ </div>
284
+ </div>
285
+ </section>
286
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
287
+ <a name="updatedAt" class="tsd-anchor"></a>
288
+ <h3>updated<wbr>At</h3>
289
+ <div class="tsd-signature tsd-kind-icon">updated<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
290
+ <aside class="tsd-sources">
291
+ <ul>
292
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1076">datatypes.ts:1076</a></li>
293
+ </ul>
294
+ </aside>
295
+ <div class="tsd-comment tsd-typography">
296
+ <div class="lead">
297
+ <p>timestamp when the endpoint was updated in RFC 3339 format</p>
298
+ </div>
299
+ </div>
300
+ </section>
301
+ </section>
302
+ </div>
303
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
304
+ <nav class="tsd-navigation primary">
305
+ <ul>
306
+ <li class=" ">
307
+ <a href="../modules.html">Modules</a>
308
+ </li>
309
+ <li class=" tsd-kind-module">
310
+ <a href="../modules/client.html">client</a>
311
+ </li>
312
+ <li class="current tsd-kind-module">
313
+ <a href="../modules/datatypes.html">datatypes</a>
314
+ </li>
315
+ <li class=" tsd-kind-module">
316
+ <a href="../modules/services.html">services</a>
317
+ </li>
318
+ </ul>
319
+ </nav>
320
+ <nav class="tsd-navigation secondary menu-sticky">
321
+ <ul class="before-current">
322
+ </ul>
323
+ <ul class="current">
324
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
325
+ <a href="datatypes.Endpoint.html" class="tsd-kind-icon">Endpoint</a>
326
+ <ul>
327
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
328
+ <a href="datatypes.Endpoint.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
329
+ </li>
330
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
331
+ <a href="datatypes.Endpoint.html#domain" class="tsd-kind-icon">domain</a>
332
+ </li>
333
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
334
+ <a href="datatypes.Endpoint.html#edge" class="tsd-kind-icon">edge</a>
335
+ </li>
336
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
337
+ <a href="datatypes.Endpoint.html#hostport" class="tsd-kind-icon">hostport</a>
338
+ </li>
339
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
340
+ <a href="datatypes.Endpoint.html#id" class="tsd-kind-icon">id</a>
341
+ </li>
342
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
343
+ <a href="datatypes.Endpoint.html#metadata" class="tsd-kind-icon">metadata</a>
344
+ </li>
345
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
346
+ <a href="datatypes.Endpoint.html#proto" class="tsd-kind-icon">proto</a>
347
+ </li>
348
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
349
+ <a href="datatypes.Endpoint.html#publicUrl" class="tsd-kind-icon">public<wbr>Url</a>
350
+ </li>
351
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
352
+ <a href="datatypes.Endpoint.html#region" class="tsd-kind-icon">region</a>
353
+ </li>
354
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
355
+ <a href="datatypes.Endpoint.html#tcpAddr" class="tsd-kind-icon">tcp<wbr>Addr</a>
356
+ </li>
357
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
358
+ <a href="datatypes.Endpoint.html#tunnel" class="tsd-kind-icon">tunnel</a>
359
+ </li>
360
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
361
+ <a href="datatypes.Endpoint.html#type" class="tsd-kind-icon">type</a>
362
+ </li>
363
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
364
+ <a href="datatypes.Endpoint.html#updatedAt" class="tsd-kind-icon">updated<wbr>At</a>
365
+ </li>
366
+ </ul>
367
+ </li>
368
+ </ul>
369
+ <ul class="after-current">
370
+ </ul>
371
+ </nav>
372
+ </div>
373
+ </div>
374
+ </div>
375
+ <footer class="with-border-bottom">
376
+ <div class="container">
377
+ <h2>Legend</h2>
378
+ <div class="tsd-legend-group">
379
+ <ul class="tsd-legend">
380
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
381
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
382
+ </ul>
383
+ <ul class="tsd-legend">
384
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
385
+ </ul>
386
+ </div>
387
+ </div>
388
+ </footer>
389
+ <div class="container tsd-generator">
390
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
391
+ </div>
392
+ <div class="overlay"></div>
393
+ <script src="../assets/js/main.js"></script>
394
+ </body>
395
+ </html>
package/docs/interfaces/{endpointbackend.html → datatypes.EndpointBackend.html} RENAMED
@@ -55,7 +55,10 @@
55
55
  <a href="../modules.html">@ngrok/ngrok-api</a>
56
56
  </li>
57
57
  <li>
58
- <a href="endpointbackend.html">EndpointBackend</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointBackend.html">EndpointBackend</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointBackend</h1>
@@ -80,8 +83,8 @@
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="endpointbackend.html#backend" class="tsd-kind-icon">backend</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointbackend.html#enabled" class="tsd-kind-icon">enabled</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointBackend.html#backend" class="tsd-kind-icon">backend</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointBackend.html#enabled" class="tsd-kind-icon">enabled</a></li>
85
88
  </ul>
86
89
  </section>
87
90
  </div>
@@ -92,10 +95,10 @@
92
95
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
93
96
  <a name="backend" class="tsd-anchor"></a>
94
97
  <h3>backend</h3>
95
- <div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
98
+ <div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
96
99
  <aside class="tsd-sources">
97
100
  <ul>
98
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L742">types.ts:742</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L675">datatypes.ts:675</a></li>
99
102
  </ul>
100
103
  </aside>
101
104
  <div class="tsd-comment tsd-typography">
@@ -110,12 +113,12 @@
110
113
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
111
114
  <aside class="tsd-sources">
112
115
  <ul>
113
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L740">types.ts:740</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L673">datatypes.ts:673</a></li>
114
117
  </ul>
115
118
  </aside>
116
119
  <div class="tsd-comment tsd-typography">
117
120
  <div class="lead">
118
- <p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
121
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
119
122
  </div>
120
123
  </div>
121
124
  </section>
@@ -125,7 +128,16 @@
125
128
  <nav class="tsd-navigation primary">
126
129
  <ul>
127
130
  <li class=" ">
128
- <a href="../modules.html">Exports</a>
131
+ <a href="../modules.html">Modules</a>
132
+ </li>
133
+ <li class=" tsd-kind-module">
134
+ <a href="../modules/client.html">client</a>
135
+ </li>
136
+ <li class="current tsd-kind-module">
137
+ <a href="../modules/datatypes.html">datatypes</a>
138
+ </li>
139
+ <li class=" tsd-kind-module">
140
+ <a href="../modules/services.html">services</a>
129
141
  </li>
130
142
  </ul>
131
143
  </nav>
@@ -133,14 +145,14 @@
133
145
  <ul class="before-current">
134
146
  </ul>
135
147
  <ul class="current">
136
- <li class="current tsd-kind-interface">
137
- <a href="endpointbackend.html" class="tsd-kind-icon">Endpoint<wbr>Backend</a>
148
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
149
+ <a href="datatypes.EndpointBackend.html" class="tsd-kind-icon">Endpoint<wbr>Backend</a>
138
150
  <ul>
139
151
  <li class=" tsd-kind-property tsd-parent-kind-interface">
140
- <a href="endpointbackend.html#backend" class="tsd-kind-icon">backend</a>
152
+ <a href="datatypes.EndpointBackend.html#backend" class="tsd-kind-icon">backend</a>
141
153
  </li>
142
154
  <li class=" tsd-kind-property tsd-parent-kind-interface">
143
- <a href="endpointbackend.html#enabled" class="tsd-kind-icon">enabled</a>
155
+ <a href="datatypes.EndpointBackend.html#enabled" class="tsd-kind-icon">enabled</a>
144
156
  </li>
145
157
  </ul>
146
158
  </li>
@@ -156,11 +168,11 @@
156
168
  <h2>Legend</h2>
157
169
  <div class="tsd-legend-group">
158
170
  <ul class="tsd-legend">
159
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
160
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
171
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
172
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
161
173
  </ul>
162
174
  <ul class="tsd-legend">
163
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
175
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
164
176
  </ul>
165
177
  </div>
166
178
  </div>
package/docs/interfaces/{endpointlogging.html → datatypes.EndpointBackendMutate.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>EndpointLogging | @ngrok/ngrok-api</title>
6
+ <title>EndpointBackendMutate | @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="endpointlogging.html">EndpointLogging</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointBackendMutate.html">EndpointBackendMutate</a>
59
62
  </li>
60
63
  </ul>
61
- <h1>Interface EndpointLogging</h1>
64
+ <h1>Interface EndpointBackendMutate</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">EndpointLogging</span>
75
+ <span class="target">EndpointBackendMutate</span>
73
76
  </li>
74
77
  </ul>
75
78
  </section>
@@ -80,8 +83,8 @@
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="endpointlogging.html#enabled" class="tsd-kind-icon">enabled</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointlogging.html#event_streams" class="tsd-kind-icon">event_<wbr>streams</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointBackendMutate.html#backendId" class="tsd-kind-icon">backend<wbr>Id</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointBackendMutate.html#enabled" class="tsd-kind-icon">enabled</a></li>
85
88
  </ul>
86
89
  </section>
87
90
  </div>
@@ -90,32 +93,32 @@
90
93
  <section class="tsd-panel-group tsd-member-group ">
91
94
  <h2>Properties</h2>
92
95
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
93
- <a name="enabled" class="tsd-anchor"></a>
94
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> enabled</h3>
95
- <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
96
+ <a name="backendId" class="tsd-anchor"></a>
97
+ <h3>backend<wbr>Id</h3>
98
+ <div class="tsd-signature tsd-kind-icon">backend<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
96
99
  <aside class="tsd-sources">
97
100
  <ul>
98
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L523">types.ts:523</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L682">datatypes.ts:682</a></li>
99
102
  </ul>
100
103
  </aside>
101
104
  <div class="tsd-comment tsd-typography">
102
105
  <div class="lead">
103
- <p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
106
+ <p>backend to be used to back this endpoint</p>
104
107
  </div>
105
108
  </div>
106
109
  </section>
107
110
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
108
- <a name="event_streams" class="tsd-anchor"></a>
109
- <h3>event_<wbr>streams</h3>
110
- <div class="tsd-signature tsd-kind-icon">event_<wbr>streams<span class="tsd-signature-symbol">:</span> <a href="ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a><span class="tsd-signature-symbol">[]</span></div>
111
+ <a name="enabled" class="tsd-anchor"></a>
112
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> enabled</h3>
113
+ <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
111
114
  <aside class="tsd-sources">
112
115
  <ul>
113
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L525">types.ts:525</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L680">datatypes.ts:680</a></li>
114
117
  </ul>
115
118
  </aside>
116
119
  <div class="tsd-comment tsd-typography">
117
120
  <div class="lead">
118
- <p>list of all EventStreams that will be used to configure and export this endpoint&#39;s logs</p>
121
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
119
122
  </div>
120
123
  </div>
121
124
  </section>
@@ -125,7 +128,16 @@
125
128
  <nav class="tsd-navigation primary">
126
129
  <ul>
127
130
  <li class=" ">
128
- <a href="../modules.html">Exports</a>
131
+ <a href="../modules.html">Modules</a>
132
+ </li>
133
+ <li class=" tsd-kind-module">
134
+ <a href="../modules/client.html">client</a>
135
+ </li>
136
+ <li class="current tsd-kind-module">
137
+ <a href="../modules/datatypes.html">datatypes</a>
138
+ </li>
139
+ <li class=" tsd-kind-module">
140
+ <a href="../modules/services.html">services</a>
129
141
  </li>
130
142
  </ul>
131
143
  </nav>
@@ -133,14 +145,14 @@
133
145
  <ul class="before-current">
134
146
  </ul>
135
147
  <ul class="current">
136
- <li class="current tsd-kind-interface">
137
- <a href="endpointlogging.html" class="tsd-kind-icon">Endpoint<wbr>Logging</a>
148
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
149
+ <a href="datatypes.EndpointBackendMutate.html" class="tsd-kind-icon">Endpoint<wbr>Backend<wbr>Mutate</a>
138
150
  <ul>
139
151
  <li class=" tsd-kind-property tsd-parent-kind-interface">
140
- <a href="endpointlogging.html#enabled" class="tsd-kind-icon">enabled</a>
152
+ <a href="datatypes.EndpointBackendMutate.html#backendId" class="tsd-kind-icon">backend<wbr>Id</a>
141
153
  </li>
142
154
  <li class=" tsd-kind-property tsd-parent-kind-interface">
143
- <a href="endpointlogging.html#event_streams" class="tsd-kind-icon">event_<wbr>streams</a>
155
+ <a href="datatypes.EndpointBackendMutate.html#enabled" class="tsd-kind-icon">enabled</a>
144
156
  </li>
145
157
  </ul>
146
158
  </li>
@@ -156,11 +168,11 @@
156
168
  <h2>Legend</h2>
157
169
  <div class="tsd-legend-group">
158
170
  <ul class="tsd-legend">
159
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
160
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
171
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
172
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
161
173
  </ul>
162
174
  <ul class="tsd-legend">
163
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
175
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
164
176
  </ul>
165
177
  </div>
166
178
  </div>