@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/{endpointconfigurationcreate.html → datatypes.HTTPSEdgeRouteCreate.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>EndpointConfigurationCreate | @ngrok/ngrok-api</title>
6
+ <title>HTTPSEdgeRouteCreate | @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="endpointconfigurationcreate.html">EndpointConfigurationCreate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.HTTPSEdgeRouteCreate.html">HTTPSEdgeRouteCreate</a>
59
62
  </li>
60
63
  </ul>
61
- <h1>Interface EndpointConfigurationCreate</h1>
64
+ <h1>Interface HTTPSEdgeRouteCreate</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">EndpointConfigurationCreate</span>
75
+ <span class="target">HTTPSEdgeRouteCreate</span>
73
76
  </li>
74
77
  </ul>
75
78
  </section>
@@ -80,21 +83,22 @@
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="endpointconfigurationcreate.html#circuit_breaker" class="tsd-kind-icon">circuit_<wbr>breaker</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfigurationcreate.html#compression" class="tsd-kind-icon">compression</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfigurationcreate.html#description" class="tsd-kind-icon">description</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfigurationcreate.html#ip_policy" class="tsd-kind-icon">ip_<wbr>policy</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfigurationcreate.html#logging" class="tsd-kind-icon">logging</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfigurationcreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfigurationcreate.html#mutual_tls" class="tsd-kind-icon">mutual_<wbr>tls</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfigurationcreate.html#oauth" class="tsd-kind-icon">oauth</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfigurationcreate.html#oidc" class="tsd-kind-icon">oidc</a></li>
92
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfigurationcreate.html#request_headers" class="tsd-kind-icon">request_<wbr>headers</a></li>
93
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfigurationcreate.html#response_headers" class="tsd-kind-icon">response_<wbr>headers</a></li>
94
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfigurationcreate.html#saml" class="tsd-kind-icon">saml</a></li>
95
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfigurationcreate.html#tls_termination" class="tsd-kind-icon">tls_<wbr>termination</a></li>
96
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfigurationcreate.html#type" class="tsd-kind-icon">type</a></li>
97
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfigurationcreate.html#webhook_validation" class="tsd-kind-icon">webhook_<wbr>validation</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#backend" class="tsd-kind-icon">backend</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#compression" class="tsd-kind-icon">compression</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#description" class="tsd-kind-icon">description</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#edgeId" class="tsd-kind-icon">edge<wbr>Id</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#match" class="tsd-kind-icon">match</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#matchType" class="tsd-kind-icon">match<wbr>Type</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#oauth" class="tsd-kind-icon">oauth</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#oidc" class="tsd-kind-icon">oidc</a></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a></li>
98
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a></li>
99
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#saml" class="tsd-kind-icon">saml</a></li>
100
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a></li>
101
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteCreate.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</a></li>
98
102
  </ul>
99
103
  </section>
100
104
  </div>
@@ -103,32 +107,47 @@
103
107
  <section class="tsd-panel-group tsd-member-group ">
104
108
  <h2>Properties</h2>
105
109
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
106
- <a name="circuit_breaker" class="tsd-anchor"></a>
107
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> circuit_<wbr>breaker</h3>
108
- <div class="tsd-signature tsd-kind-icon">circuit_<wbr>breaker<span class="tsd-signature-symbol">:</span> <a href="endpointcircuitbreaker.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCircuitBreaker</a></div>
110
+ <a name="backend" class="tsd-anchor"></a>
111
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> backend</h3>
112
+ <div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackendMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackendMutate</a></div>
109
113
  <aside class="tsd-sources">
110
114
  <ul>
111
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L457">types.ts:457</a></li>
115
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L709">datatypes.ts:709</a></li>
112
116
  </ul>
113
117
  </aside>
114
118
  <div class="tsd-comment tsd-typography">
115
119
  <div class="lead">
116
- <p>circuit breaker module configuration or null</p>
120
+ <p>backend module configuration or <code>null</code></p>
121
+ </div>
122
+ </div>
123
+ </section>
124
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
125
+ <a name="circuitBreaker" class="tsd-anchor"></a>
126
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> circuit<wbr>Breaker</h3>
127
+ <div class="tsd-signature tsd-kind-icon">circuit<wbr>Breaker<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCircuitBreaker.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCircuitBreaker</a></div>
128
+ <aside class="tsd-sources">
129
+ <ul>
130
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L713">datatypes.ts:713</a></li>
131
+ </ul>
132
+ </aside>
133
+ <div class="tsd-comment tsd-typography">
134
+ <div class="lead">
135
+ <p>circuit breaker module configuration or <code>null</code></p>
117
136
  </div>
118
137
  </div>
119
138
  </section>
120
139
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
121
140
  <a name="compression" class="tsd-anchor"></a>
122
141
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> compression</h3>
123
- <div class="tsd-signature tsd-kind-icon">compression<span class="tsd-signature-symbol">:</span> <a href="endpointcompression.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCompression</a></div>
142
+ <div class="tsd-signature tsd-kind-icon">compression<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCompression.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCompression</a></div>
124
143
  <aside class="tsd-sources">
125
144
  <ul>
126
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L459">types.ts:459</a></li>
145
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L715">datatypes.ts:715</a></li>
127
146
  </ul>
128
147
  </aside>
129
148
  <div class="tsd-comment tsd-typography">
130
149
  <div class="lead">
131
- <p>compression module configuration or null</p>
150
+ <p>compression module configuration or <code>null</code></p>
132
151
  </div>
133
152
  </div>
134
153
  </section>
@@ -138,192 +157,192 @@
138
157
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
139
158
  <aside class="tsd-sources">
140
159
  <ul>
141
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L453">types.ts:453</a></li>
160
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L705">datatypes.ts:705</a></li>
142
161
  </ul>
143
162
  </aside>
144
163
  <div class="tsd-comment tsd-typography">
145
164
  <div class="lead">
146
- <p>human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p>
165
+ <p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
147
166
  </div>
148
167
  </div>
149
168
  </section>
150
169
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
151
- <a name="ip_policy" class="tsd-anchor"></a>
152
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip_<wbr>policy</h3>
153
- <div class="tsd-signature tsd-kind-icon">ip_<wbr>policy<span class="tsd-signature-symbol">:</span> <a href="endpointippolicymutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicyMutate</a></div>
170
+ <a name="edgeId" class="tsd-anchor"></a>
171
+ <h3>edge<wbr>Id</h3>
172
+ <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
154
173
  <aside class="tsd-sources">
155
174
  <ul>
156
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L465">types.ts:465</a></li>
175
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L699">datatypes.ts:699</a></li>
157
176
  </ul>
158
177
  </aside>
159
178
  <div class="tsd-comment tsd-typography">
160
179
  <div class="lead">
161
- <p>ip policy module configuration or null</p>
180
+ <p>unique identifier of this edge</p>
162
181
  </div>
163
182
  </div>
164
183
  </section>
165
184
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
166
- <a name="logging" class="tsd-anchor"></a>
167
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> logging</h3>
168
- <div class="tsd-signature tsd-kind-icon">logging<span class="tsd-signature-symbol">:</span> <a href="endpointloggingmutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointLoggingMutate</a></div>
185
+ <a name="ipRestriction" class="tsd-anchor"></a>
186
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip<wbr>Restriction</h3>
187
+ <div class="tsd-signature tsd-kind-icon">ip<wbr>Restriction<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicyMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicyMutate</a></div>
169
188
  <aside class="tsd-sources">
170
189
  <ul>
171
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L475">types.ts:475</a></li>
190
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L711">datatypes.ts:711</a></li>
172
191
  </ul>
173
192
  </aside>
174
193
  <div class="tsd-comment tsd-typography">
175
194
  <div class="lead">
176
- <p>logging module configuration or null</p>
195
+ <p>ip restriction module configuration or <code>null</code></p>
177
196
  </div>
178
197
  </div>
179
198
  </section>
180
199
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
181
- <a name="metadata" class="tsd-anchor"></a>
182
- <h3>metadata</h3>
183
- <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
200
+ <a name="match" class="tsd-anchor"></a>
201
+ <h3>match</h3>
202
+ <div class="tsd-signature tsd-kind-icon">match<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
184
203
  <aside class="tsd-sources">
185
204
  <ul>
186
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L455">types.ts:455</a></li>
205
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L703">datatypes.ts:703</a></li>
187
206
  </ul>
188
207
  </aside>
189
208
  <div class="tsd-comment tsd-typography">
190
209
  <div class="lead">
191
- <p>arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p>
210
+ <p>Route selector: &quot;/blog&quot; or &quot;example.com&quot; or &quot;example.com/blog&quot;</p>
192
211
  </div>
193
212
  </div>
194
213
  </section>
195
214
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
196
- <a name="mutual_tls" class="tsd-anchor"></a>
197
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> mutual_<wbr>tls</h3>
198
- <div class="tsd-signature tsd-kind-icon">mutual_<wbr>tls<span class="tsd-signature-symbol">:</span> <a href="endpointmutualtlsmutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLSMutate</a></div>
215
+ <a name="matchType" class="tsd-anchor"></a>
216
+ <h3>match<wbr>Type</h3>
217
+ <div class="tsd-signature tsd-kind-icon">match<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
199
218
  <aside class="tsd-sources">
200
219
  <ul>
201
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L467">types.ts:467</a></li>
220
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L701">datatypes.ts:701</a></li>
202
221
  </ul>
203
222
  </aside>
204
223
  <div class="tsd-comment tsd-typography">
205
224
  <div class="lead">
206
- <p>mutual TLS module configuration or null</p>
225
+ <p>Type of match to use for this route. Valid values are &quot;exact_path&quot; and &quot;path_prefix&quot;.</p>
207
226
  </div>
208
227
  </div>
209
228
  </section>
210
229
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
211
- <a name="oauth" class="tsd-anchor"></a>
212
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> oauth</h3>
213
- <div class="tsd-signature tsd-kind-icon">oauth<span class="tsd-signature-symbol">:</span> <a href="endpointoauth.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuth</a></div>
230
+ <a name="metadata" class="tsd-anchor"></a>
231
+ <h3>metadata</h3>
232
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
214
233
  <aside class="tsd-sources">
215
234
  <ul>
216
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L473">types.ts:473</a></li>
235
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L707">datatypes.ts:707</a></li>
217
236
  </ul>
218
237
  </aside>
219
238
  <div class="tsd-comment tsd-typography">
220
239
  <div class="lead">
221
- <p>oauth module configuration or null</p>
240
+ <p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
222
241
  </div>
223
242
  </div>
224
243
  </section>
225
244
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
226
- <a name="oidc" class="tsd-anchor"></a>
227
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> oidc</h3>
228
- <div class="tsd-signature tsd-kind-icon">oidc<span class="tsd-signature-symbol">:</span> <a href="endpointoidc.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOIDC</a></div>
245
+ <a name="oauth" class="tsd-anchor"></a>
246
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> oauth</h3>
247
+ <div class="tsd-signature tsd-kind-icon">oauth<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuth</a></div>
229
248
  <aside class="tsd-sources">
230
249
  <ul>
231
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L479">types.ts:479</a></li>
250
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L723">datatypes.ts:723</a></li>
232
251
  </ul>
233
252
  </aside>
234
253
  <div class="tsd-comment tsd-typography">
235
254
  <div class="lead">
236
- <p>oidc module configuration or null</p>
255
+ <p>oauth module configuration or <code>null</code></p>
237
256
  </div>
238
257
  </div>
239
258
  </section>
240
259
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
241
- <a name="request_headers" class="tsd-anchor"></a>
242
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> request_<wbr>headers</h3>
243
- <div class="tsd-signature tsd-kind-icon">request_<wbr>headers<span class="tsd-signature-symbol">:</span> <a href="endpointrequestheaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointRequestHeaders</a></div>
260
+ <a name="oidc" class="tsd-anchor"></a>
261
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> oidc</h3>
262
+ <div class="tsd-signature tsd-kind-icon">oidc<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOIDC.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOIDC</a></div>
244
263
  <aside class="tsd-sources">
245
264
  <ul>
246
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L461">types.ts:461</a></li>
265
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L727">datatypes.ts:727</a></li>
247
266
  </ul>
248
267
  </aside>
249
268
  <div class="tsd-comment tsd-typography">
250
269
  <div class="lead">
251
- <p>request headers module configuration or null</p>
270
+ <p>oidc module configuration or <code>null</code></p>
252
271
  </div>
253
272
  </div>
254
273
  </section>
255
274
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
256
- <a name="response_headers" class="tsd-anchor"></a>
257
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> response_<wbr>headers</h3>
258
- <div class="tsd-signature tsd-kind-icon">response_<wbr>headers<span class="tsd-signature-symbol">:</span> <a href="endpointresponseheaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointResponseHeaders</a></div>
275
+ <a name="requestHeaders" class="tsd-anchor"></a>
276
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> request<wbr>Headers</h3>
277
+ <div class="tsd-signature tsd-kind-icon">request<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointRequestHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointRequestHeaders</a></div>
259
278
  <aside class="tsd-sources">
260
279
  <ul>
261
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L463">types.ts:463</a></li>
280
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L717">datatypes.ts:717</a></li>
262
281
  </ul>
263
282
  </aside>
264
283
  <div class="tsd-comment tsd-typography">
265
284
  <div class="lead">
266
- <p>response headers module configuration or null</p>
285
+ <p>request headers module configuration or <code>null</code></p>
267
286
  </div>
268
287
  </div>
269
288
  </section>
270
289
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
271
- <a name="saml" class="tsd-anchor"></a>
272
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> saml</h3>
273
- <div class="tsd-signature tsd-kind-icon">saml<span class="tsd-signature-symbol">:</span> <a href="endpointsamlmutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAMLMutate</a></div>
290
+ <a name="responseHeaders" class="tsd-anchor"></a>
291
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> response<wbr>Headers</h3>
292
+ <div class="tsd-signature tsd-kind-icon">response<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointResponseHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointResponseHeaders</a></div>
274
293
  <aside class="tsd-sources">
275
294
  <ul>
276
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L477">types.ts:477</a></li>
295
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L719">datatypes.ts:719</a></li>
277
296
  </ul>
278
297
  </aside>
279
298
  <div class="tsd-comment tsd-typography">
280
299
  <div class="lead">
281
- <p>saml module configuration or null</p>
300
+ <p>response headers module configuration or <code>null</code></p>
282
301
  </div>
283
302
  </div>
284
303
  </section>
285
304
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
286
- <a name="tls_termination" class="tsd-anchor"></a>
287
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> tls_<wbr>termination</h3>
288
- <div class="tsd-signature tsd-kind-icon">tls_<wbr>termination<span class="tsd-signature-symbol">:</span> <a href="endpointtlstermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</a></div>
305
+ <a name="saml" class="tsd-anchor"></a>
306
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> saml</h3>
307
+ <div class="tsd-signature tsd-kind-icon">saml<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointSAMLMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAMLMutate</a></div>
289
308
  <aside class="tsd-sources">
290
309
  <ul>
291
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L469">types.ts:469</a></li>
310
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L725">datatypes.ts:725</a></li>
292
311
  </ul>
293
312
  </aside>
294
313
  <div class="tsd-comment tsd-typography">
295
314
  <div class="lead">
296
- <p>TLS termination module configuration or null</p>
315
+ <p>saml module configuration or <code>null</code></p>
297
316
  </div>
298
317
  </div>
299
318
  </section>
300
319
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
301
- <a name="type" class="tsd-anchor"></a>
302
- <h3>type</h3>
303
- <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
320
+ <a name="webhookVerification" class="tsd-anchor"></a>
321
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> webhook<wbr>Verification</h3>
322
+ <div class="tsd-signature tsd-kind-icon">webhook<wbr>Verification<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebhookValidation.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebhookValidation</a></div>
304
323
  <aside class="tsd-sources">
305
324
  <ul>
306
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L451">types.ts:451</a></li>
325
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L721">datatypes.ts:721</a></li>
307
326
  </ul>
308
327
  </aside>
309
328
  <div class="tsd-comment tsd-typography">
310
329
  <div class="lead">
311
- <p>they type of traffic this endpoint configuration can be applied to. one of: http, https, tcp</p>
330
+ <p>webhook verification module configuration or <code>null</code></p>
312
331
  </div>
313
332
  </div>
314
333
  </section>
315
334
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
316
- <a name="webhook_validation" class="tsd-anchor"></a>
317
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> webhook_<wbr>validation</h3>
318
- <div class="tsd-signature tsd-kind-icon">webhook_<wbr>validation<span class="tsd-signature-symbol">:</span> <a href="endpointwebhookvalidation.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebhookValidation</a></div>
335
+ <a name="websocketTcpConverter" class="tsd-anchor"></a>
336
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> websocket<wbr>Tcp<wbr>Converter</h3>
337
+ <div class="tsd-signature tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebsocketTCPConverter.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebsocketTCPConverter</a></div>
319
338
  <aside class="tsd-sources">
320
339
  <ul>
321
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L471">types.ts:471</a></li>
340
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L729">datatypes.ts:729</a></li>
322
341
  </ul>
323
342
  </aside>
324
343
  <div class="tsd-comment tsd-typography">
325
344
  <div class="lead">
326
- <p>webhook validation module configuration or null</p>
345
+ <p>websocket to tcp adapter configuration or <code>null</code></p>
327
346
  </div>
328
347
  </div>
329
348
  </section>
@@ -333,7 +352,16 @@
333
352
  <nav class="tsd-navigation primary">
334
353
  <ul>
335
354
  <li class=" ">
336
- <a href="../modules.html">Exports</a>
355
+ <a href="../modules.html">Modules</a>
356
+ </li>
357
+ <li class=" tsd-kind-module">
358
+ <a href="../modules/client.html">client</a>
359
+ </li>
360
+ <li class="current tsd-kind-module">
361
+ <a href="../modules/datatypes.html">datatypes</a>
362
+ </li>
363
+ <li class=" tsd-kind-module">
364
+ <a href="../modules/services.html">services</a>
337
365
  </li>
338
366
  </ul>
339
367
  </nav>
@@ -341,53 +369,56 @@
341
369
  <ul class="before-current">
342
370
  </ul>
343
371
  <ul class="current">
344
- <li class="current tsd-kind-interface">
345
- <a href="endpointconfigurationcreate.html" class="tsd-kind-icon">Endpoint<wbr>Configuration<wbr>Create</a>
372
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
373
+ <a href="datatypes.HTTPSEdgeRouteCreate.html" class="tsd-kind-icon">HTTPSEdge<wbr>Route<wbr>Create</a>
346
374
  <ul>
347
375
  <li class=" tsd-kind-property tsd-parent-kind-interface">
348
- <a href="endpointconfigurationcreate.html#circuit_breaker" class="tsd-kind-icon">circuit_<wbr>breaker</a>
376
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#backend" class="tsd-kind-icon">backend</a>
349
377
  </li>
350
378
  <li class=" tsd-kind-property tsd-parent-kind-interface">
351
- <a href="endpointconfigurationcreate.html#compression" class="tsd-kind-icon">compression</a>
379
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a>
352
380
  </li>
353
381
  <li class=" tsd-kind-property tsd-parent-kind-interface">
354
- <a href="endpointconfigurationcreate.html#description" class="tsd-kind-icon">description</a>
382
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#compression" class="tsd-kind-icon">compression</a>
355
383
  </li>
356
384
  <li class=" tsd-kind-property tsd-parent-kind-interface">
357
- <a href="endpointconfigurationcreate.html#ip_policy" class="tsd-kind-icon">ip_<wbr>policy</a>
385
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#description" class="tsd-kind-icon">description</a>
358
386
  </li>
359
387
  <li class=" tsd-kind-property tsd-parent-kind-interface">
360
- <a href="endpointconfigurationcreate.html#logging" class="tsd-kind-icon">logging</a>
388
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#edgeId" class="tsd-kind-icon">edge<wbr>Id</a>
361
389
  </li>
362
390
  <li class=" tsd-kind-property tsd-parent-kind-interface">
363
- <a href="endpointconfigurationcreate.html#metadata" class="tsd-kind-icon">metadata</a>
391
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a>
364
392
  </li>
365
393
  <li class=" tsd-kind-property tsd-parent-kind-interface">
366
- <a href="endpointconfigurationcreate.html#mutual_tls" class="tsd-kind-icon">mutual_<wbr>tls</a>
394
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#match" class="tsd-kind-icon">match</a>
367
395
  </li>
368
396
  <li class=" tsd-kind-property tsd-parent-kind-interface">
369
- <a href="endpointconfigurationcreate.html#oauth" class="tsd-kind-icon">oauth</a>
397
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#matchType" class="tsd-kind-icon">match<wbr>Type</a>
370
398
  </li>
371
399
  <li class=" tsd-kind-property tsd-parent-kind-interface">
372
- <a href="endpointconfigurationcreate.html#oidc" class="tsd-kind-icon">oidc</a>
400
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#metadata" class="tsd-kind-icon">metadata</a>
373
401
  </li>
374
402
  <li class=" tsd-kind-property tsd-parent-kind-interface">
375
- <a href="endpointconfigurationcreate.html#request_headers" class="tsd-kind-icon">request_<wbr>headers</a>
403
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#oauth" class="tsd-kind-icon">oauth</a>
376
404
  </li>
377
405
  <li class=" tsd-kind-property tsd-parent-kind-interface">
378
- <a href="endpointconfigurationcreate.html#response_headers" class="tsd-kind-icon">response_<wbr>headers</a>
406
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#oidc" class="tsd-kind-icon">oidc</a>
379
407
  </li>
380
408
  <li class=" tsd-kind-property tsd-parent-kind-interface">
381
- <a href="endpointconfigurationcreate.html#saml" class="tsd-kind-icon">saml</a>
409
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a>
382
410
  </li>
383
411
  <li class=" tsd-kind-property tsd-parent-kind-interface">
384
- <a href="endpointconfigurationcreate.html#tls_termination" class="tsd-kind-icon">tls_<wbr>termination</a>
412
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a>
385
413
  </li>
386
414
  <li class=" tsd-kind-property tsd-parent-kind-interface">
387
- <a href="endpointconfigurationcreate.html#type" class="tsd-kind-icon">type</a>
415
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#saml" class="tsd-kind-icon">saml</a>
388
416
  </li>
389
417
  <li class=" tsd-kind-property tsd-parent-kind-interface">
390
- <a href="endpointconfigurationcreate.html#webhook_validation" class="tsd-kind-icon">webhook_<wbr>validation</a>
418
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a>
419
+ </li>
420
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
421
+ <a href="datatypes.HTTPSEdgeRouteCreate.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</a>
391
422
  </li>
392
423
  </ul>
393
424
  </li>
@@ -403,11 +434,11 @@
403
434
  <h2>Legend</h2>
404
435
  <div class="tsd-legend-group">
405
436
  <ul class="tsd-legend">
406
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
407
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
437
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
438
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
408
439
  </ul>
409
440
  <ul class="tsd-legend">
410
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
441
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
411
442
  </ul>
412
443
  </div>
413
444
  </div>