@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/{endpointconfiguration.html → datatypes.HTTPSEdgeRouteUpdate.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>EndpointConfiguration | @ngrok/ngrok-api</title>
6
+ <title>HTTPSEdgeRouteUpdate | @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="endpointconfiguration.html">EndpointConfiguration</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html">HTTPSEdgeRouteUpdate</a>
59
62
  </li>
60
63
  </ul>
61
- <h1>Interface EndpointConfiguration</h1>
64
+ <h1>Interface HTTPSEdgeRouteUpdate</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">EndpointConfiguration</span>
75
+ <span class="target">HTTPSEdgeRouteUpdate</span>
73
76
  </li>
74
77
  </ul>
75
78
  </section>
@@ -80,24 +83,23 @@
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="endpointconfiguration.html#circuit_breaker" class="tsd-kind-icon">circuit_<wbr>breaker</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#compression" class="tsd-kind-icon">compression</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#created_at" class="tsd-kind-icon">created_<wbr>at</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#description" class="tsd-kind-icon">description</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#id" class="tsd-kind-icon">id</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#ip_policy" class="tsd-kind-icon">ip_<wbr>policy</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#logging" class="tsd-kind-icon">logging</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#metadata" class="tsd-kind-icon">metadata</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#mutual_tls" class="tsd-kind-icon">mutual_<wbr>tls</a></li>
92
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#oauth" class="tsd-kind-icon">oauth</a></li>
93
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#oidc" class="tsd-kind-icon">oidc</a></li>
94
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#request_headers" class="tsd-kind-icon">request_<wbr>headers</a></li>
95
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#response_headers" class="tsd-kind-icon">response_<wbr>headers</a></li>
96
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#saml" class="tsd-kind-icon">saml</a></li>
97
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#tls_termination" class="tsd-kind-icon">tls_<wbr>termination</a></li>
98
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#type" class="tsd-kind-icon">type</a></li>
99
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.html#uri" class="tsd-kind-icon">uri</a></li>
100
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointconfiguration.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.HTTPSEdgeRouteUpdate.html#backend" class="tsd-kind-icon">backend</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#compression" class="tsd-kind-icon">compression</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#description" class="tsd-kind-icon">description</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#edgeId" class="tsd-kind-icon">edge<wbr>Id</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#id" class="tsd-kind-icon">id</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#match" class="tsd-kind-icon">match</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#matchType" class="tsd-kind-icon">match<wbr>Type</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#oauth" class="tsd-kind-icon">oauth</a></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#oidc" class="tsd-kind-icon">oidc</a></li>
98
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a></li>
99
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a></li>
100
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#saml" class="tsd-kind-icon">saml</a></li>
101
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a></li>
102
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</a></li>
101
103
  </ul>
102
104
  </section>
103
105
  </div>
@@ -106,47 +108,47 @@
106
108
  <section class="tsd-panel-group tsd-member-group ">
107
109
  <h2>Properties</h2>
108
110
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
109
- <a name="circuit_breaker" class="tsd-anchor"></a>
110
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> circuit_<wbr>breaker</h3>
111
- <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>
111
+ <a name="backend" class="tsd-anchor"></a>
112
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> backend</h3>
113
+ <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>
112
114
  <aside class="tsd-sources">
113
115
  <ul>
114
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L382">types.ts:382</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L746">datatypes.ts:746</a></li>
115
117
  </ul>
116
118
  </aside>
117
119
  <div class="tsd-comment tsd-typography">
118
120
  <div class="lead">
119
- <p>circuit breaker module configuration or null</p>
121
+ <p>backend module configuration or <code>null</code></p>
120
122
  </div>
121
123
  </div>
122
124
  </section>
123
125
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
124
- <a name="compression" class="tsd-anchor"></a>
125
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> compression</h3>
126
- <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>
126
+ <a name="circuitBreaker" class="tsd-anchor"></a>
127
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> circuit<wbr>Breaker</h3>
128
+ <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>
127
129
  <aside class="tsd-sources">
128
130
  <ul>
129
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L384">types.ts:384</a></li>
131
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L750">datatypes.ts:750</a></li>
130
132
  </ul>
131
133
  </aside>
132
134
  <div class="tsd-comment tsd-typography">
133
135
  <div class="lead">
134
- <p>compression module configuration or null</p>
136
+ <p>circuit breaker module configuration or <code>null</code></p>
135
137
  </div>
136
138
  </div>
137
139
  </section>
138
140
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
139
- <a name="created_at" class="tsd-anchor"></a>
140
- <h3>created_<wbr>at</h3>
141
- <div class="tsd-signature tsd-kind-icon">created_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
141
+ <a name="compression" class="tsd-anchor"></a>
142
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> compression</h3>
143
+ <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>
142
144
  <aside class="tsd-sources">
143
145
  <ul>
144
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L378">types.ts:378</a></li>
146
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L752">datatypes.ts:752</a></li>
145
147
  </ul>
146
148
  </aside>
147
149
  <div class="tsd-comment tsd-typography">
148
150
  <div class="lead">
149
- <p>timestamp when the endpoint configuration was created, RFC 3339 format</p>
151
+ <p>compression module configuration or <code>null</code></p>
150
152
  </div>
151
153
  </div>
152
154
  </section>
@@ -156,222 +158,207 @@
156
158
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
157
159
  <aside class="tsd-sources">
158
160
  <ul>
159
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L374">types.ts:374</a></li>
161
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L742">datatypes.ts:742</a></li>
160
162
  </ul>
161
163
  </aside>
162
164
  <div class="tsd-comment tsd-typography">
163
165
  <div class="lead">
164
- <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>
166
+ <p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
165
167
  </div>
166
168
  </div>
167
169
  </section>
168
170
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
169
- <a name="id" class="tsd-anchor"></a>
170
- <h3>id</h3>
171
- <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
171
+ <a name="edgeId" class="tsd-anchor"></a>
172
+ <h3>edge<wbr>Id</h3>
173
+ <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
172
174
  <aside class="tsd-sources">
173
175
  <ul>
174
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L370">types.ts:370</a></li>
176
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L734">datatypes.ts:734</a></li>
175
177
  </ul>
176
178
  </aside>
177
179
  <div class="tsd-comment tsd-typography">
178
180
  <div class="lead">
179
- <p>unique identifier of this endpoint configuration</p>
181
+ <p>unique identifier of this edge</p>
180
182
  </div>
181
183
  </div>
182
184
  </section>
183
185
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
184
- <a name="ip_policy" class="tsd-anchor"></a>
185
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip_<wbr>policy</h3>
186
- <div class="tsd-signature tsd-kind-icon">ip_<wbr>policy<span class="tsd-signature-symbol">:</span> <a href="endpointippolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a></div>
186
+ <a name="id" class="tsd-anchor"></a>
187
+ <h3>id</h3>
188
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
187
189
  <aside class="tsd-sources">
188
190
  <ul>
189
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L390">types.ts:390</a></li>
191
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L736">datatypes.ts:736</a></li>
190
192
  </ul>
191
193
  </aside>
192
194
  <div class="tsd-comment tsd-typography">
193
195
  <div class="lead">
194
- <p>ip policy module configuration or null</p>
196
+ <p>unique identifier of this edge route</p>
195
197
  </div>
196
198
  </div>
197
199
  </section>
198
200
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
199
- <a name="logging" class="tsd-anchor"></a>
200
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> logging</h3>
201
- <div class="tsd-signature tsd-kind-icon">logging<span class="tsd-signature-symbol">:</span> <a href="endpointlogging.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointLogging</a></div>
201
+ <a name="ipRestriction" class="tsd-anchor"></a>
202
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip<wbr>Restriction</h3>
203
+ <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>
202
204
  <aside class="tsd-sources">
203
205
  <ul>
204
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L400">types.ts:400</a></li>
206
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L748">datatypes.ts:748</a></li>
205
207
  </ul>
206
208
  </aside>
207
209
  <div class="tsd-comment tsd-typography">
208
210
  <div class="lead">
209
- <p>logging module configuration or null</p>
211
+ <p>ip restriction module configuration or <code>null</code></p>
210
212
  </div>
211
213
  </div>
212
214
  </section>
213
215
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
214
- <a name="metadata" class="tsd-anchor"></a>
215
- <h3>metadata</h3>
216
- <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
216
+ <a name="match" class="tsd-anchor"></a>
217
+ <h3>match</h3>
218
+ <div class="tsd-signature tsd-kind-icon">match<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
217
219
  <aside class="tsd-sources">
218
220
  <ul>
219
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L376">types.ts:376</a></li>
221
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L740">datatypes.ts:740</a></li>
220
222
  </ul>
221
223
  </aside>
222
224
  <div class="tsd-comment tsd-typography">
223
225
  <div class="lead">
224
- <p>arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p>
226
+ <p>Route selector: &quot;/blog&quot; or &quot;example.com&quot; or &quot;example.com/blog&quot;</p>
225
227
  </div>
226
228
  </div>
227
229
  </section>
228
230
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
229
- <a name="mutual_tls" class="tsd-anchor"></a>
230
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> mutual_<wbr>tls</h3>
231
- <div class="tsd-signature tsd-kind-icon">mutual_<wbr>tls<span class="tsd-signature-symbol">:</span> <a href="endpointmutualtls.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLS</a></div>
231
+ <a name="matchType" class="tsd-anchor"></a>
232
+ <h3>match<wbr>Type</h3>
233
+ <div class="tsd-signature tsd-kind-icon">match<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
232
234
  <aside class="tsd-sources">
233
235
  <ul>
234
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L392">types.ts:392</a></li>
236
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L738">datatypes.ts:738</a></li>
235
237
  </ul>
236
238
  </aside>
237
239
  <div class="tsd-comment tsd-typography">
238
240
  <div class="lead">
239
- <p>mutual TLS module configuration or null</p>
241
+ <p>Type of match to use for this route. Valid values are &quot;exact_path&quot; and &quot;path_prefix&quot;.</p>
240
242
  </div>
241
243
  </div>
242
244
  </section>
243
245
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
244
- <a name="oauth" class="tsd-anchor"></a>
245
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> oauth</h3>
246
- <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>
247
- <aside class="tsd-sources">
248
- <ul>
249
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L398">types.ts:398</a></li>
250
- </ul>
251
- </aside>
252
- <div class="tsd-comment tsd-typography">
253
- <div class="lead">
254
- <p>oauth module configuration or null</p>
255
- </div>
256
- </div>
257
- </section>
258
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
259
- <a name="oidc" class="tsd-anchor"></a>
260
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> oidc</h3>
261
- <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>
246
+ <a name="metadata" class="tsd-anchor"></a>
247
+ <h3>metadata</h3>
248
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
262
249
  <aside class="tsd-sources">
263
250
  <ul>
264
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L404">types.ts:404</a></li>
251
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L744">datatypes.ts:744</a></li>
265
252
  </ul>
266
253
  </aside>
267
254
  <div class="tsd-comment tsd-typography">
268
255
  <div class="lead">
269
- <p>oidc module configuration or null</p>
256
+ <p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
270
257
  </div>
271
258
  </div>
272
259
  </section>
273
260
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
274
- <a name="request_headers" class="tsd-anchor"></a>
275
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> request_<wbr>headers</h3>
276
- <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>
261
+ <a name="oauth" class="tsd-anchor"></a>
262
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> oauth</h3>
263
+ <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>
277
264
  <aside class="tsd-sources">
278
265
  <ul>
279
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L386">types.ts:386</a></li>
266
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L760">datatypes.ts:760</a></li>
280
267
  </ul>
281
268
  </aside>
282
269
  <div class="tsd-comment tsd-typography">
283
270
  <div class="lead">
284
- <p>request headers module configuration or null</p>
271
+ <p>oauth module configuration or <code>null</code></p>
285
272
  </div>
286
273
  </div>
287
274
  </section>
288
275
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
289
- <a name="response_headers" class="tsd-anchor"></a>
290
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> response_<wbr>headers</h3>
291
- <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>
276
+ <a name="oidc" class="tsd-anchor"></a>
277
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> oidc</h3>
278
+ <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>
292
279
  <aside class="tsd-sources">
293
280
  <ul>
294
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L388">types.ts:388</a></li>
281
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L764">datatypes.ts:764</a></li>
295
282
  </ul>
296
283
  </aside>
297
284
  <div class="tsd-comment tsd-typography">
298
285
  <div class="lead">
299
- <p>response headers module configuration or null</p>
286
+ <p>oidc module configuration or <code>null</code></p>
300
287
  </div>
301
288
  </div>
302
289
  </section>
303
290
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
304
- <a name="saml" class="tsd-anchor"></a>
305
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> saml</h3>
306
- <div class="tsd-signature tsd-kind-icon">saml<span class="tsd-signature-symbol">:</span> <a href="endpointsaml.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAML</a></div>
291
+ <a name="requestHeaders" class="tsd-anchor"></a>
292
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> request<wbr>Headers</h3>
293
+ <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>
307
294
  <aside class="tsd-sources">
308
295
  <ul>
309
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L402">types.ts:402</a></li>
296
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L754">datatypes.ts:754</a></li>
310
297
  </ul>
311
298
  </aside>
312
299
  <div class="tsd-comment tsd-typography">
313
300
  <div class="lead">
314
- <p>saml module configuration or null</p>
301
+ <p>request headers module configuration or <code>null</code></p>
315
302
  </div>
316
303
  </div>
317
304
  </section>
318
305
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
319
- <a name="tls_termination" class="tsd-anchor"></a>
320
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> tls_<wbr>termination</h3>
321
- <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>
306
+ <a name="responseHeaders" class="tsd-anchor"></a>
307
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> response<wbr>Headers</h3>
308
+ <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>
322
309
  <aside class="tsd-sources">
323
310
  <ul>
324
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L394">types.ts:394</a></li>
311
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L756">datatypes.ts:756</a></li>
325
312
  </ul>
326
313
  </aside>
327
314
  <div class="tsd-comment tsd-typography">
328
315
  <div class="lead">
329
- <p>TLS termination module configuration or null</p>
316
+ <p>response headers module configuration or <code>null</code></p>
330
317
  </div>
331
318
  </div>
332
319
  </section>
333
320
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
334
- <a name="type" class="tsd-anchor"></a>
335
- <h3>type</h3>
336
- <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
321
+ <a name="saml" class="tsd-anchor"></a>
322
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> saml</h3>
323
+ <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>
337
324
  <aside class="tsd-sources">
338
325
  <ul>
339
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L372">types.ts:372</a></li>
326
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L762">datatypes.ts:762</a></li>
340
327
  </ul>
341
328
  </aside>
342
329
  <div class="tsd-comment tsd-typography">
343
330
  <div class="lead">
344
- <p>they type of traffic this endpoint configuration can be applied to. one of: http, https, tcp</p>
331
+ <p>saml module configuration or <code>null</code></p>
345
332
  </div>
346
333
  </div>
347
334
  </section>
348
335
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
349
- <a name="uri" class="tsd-anchor"></a>
350
- <h3>uri</h3>
351
- <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
336
+ <a name="webhookVerification" class="tsd-anchor"></a>
337
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> webhook<wbr>Verification</h3>
338
+ <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>
352
339
  <aside class="tsd-sources">
353
340
  <ul>
354
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L380">types.ts:380</a></li>
341
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L758">datatypes.ts:758</a></li>
355
342
  </ul>
356
343
  </aside>
357
344
  <div class="tsd-comment tsd-typography">
358
345
  <div class="lead">
359
- <p>URI of the endpoint configuration API resource</p>
346
+ <p>webhook verification module configuration or <code>null</code></p>
360
347
  </div>
361
348
  </div>
362
349
  </section>
363
350
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
364
- <a name="webhook_validation" class="tsd-anchor"></a>
365
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> webhook_<wbr>validation</h3>
366
- <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>
351
+ <a name="websocketTcpConverter" class="tsd-anchor"></a>
352
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> websocket<wbr>Tcp<wbr>Converter</h3>
353
+ <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>
367
354
  <aside class="tsd-sources">
368
355
  <ul>
369
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L396">types.ts:396</a></li>
356
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L766">datatypes.ts:766</a></li>
370
357
  </ul>
371
358
  </aside>
372
359
  <div class="tsd-comment tsd-typography">
373
360
  <div class="lead">
374
- <p>webhook validation module configuration or null</p>
361
+ <p>websocket to tcp adapter configuration or <code>null</code></p>
375
362
  </div>
376
363
  </div>
377
364
  </section>
@@ -381,7 +368,16 @@
381
368
  <nav class="tsd-navigation primary">
382
369
  <ul>
383
370
  <li class=" ">
384
- <a href="../modules.html">Exports</a>
371
+ <a href="../modules.html">Modules</a>
372
+ </li>
373
+ <li class=" tsd-kind-module">
374
+ <a href="../modules/client.html">client</a>
375
+ </li>
376
+ <li class="current tsd-kind-module">
377
+ <a href="../modules/datatypes.html">datatypes</a>
378
+ </li>
379
+ <li class=" tsd-kind-module">
380
+ <a href="../modules/services.html">services</a>
385
381
  </li>
386
382
  </ul>
387
383
  </nav>
@@ -389,62 +385,59 @@
389
385
  <ul class="before-current">
390
386
  </ul>
391
387
  <ul class="current">
392
- <li class="current tsd-kind-interface">
393
- <a href="endpointconfiguration.html" class="tsd-kind-icon">Endpoint<wbr>Configuration</a>
388
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
389
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html" class="tsd-kind-icon">HTTPSEdge<wbr>Route<wbr>Update</a>
394
390
  <ul>
395
391
  <li class=" tsd-kind-property tsd-parent-kind-interface">
396
- <a href="endpointconfiguration.html#circuit_breaker" class="tsd-kind-icon">circuit_<wbr>breaker</a>
397
- </li>
398
- <li class=" tsd-kind-property tsd-parent-kind-interface">
399
- <a href="endpointconfiguration.html#compression" class="tsd-kind-icon">compression</a>
392
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#backend" class="tsd-kind-icon">backend</a>
400
393
  </li>
401
394
  <li class=" tsd-kind-property tsd-parent-kind-interface">
402
- <a href="endpointconfiguration.html#created_at" class="tsd-kind-icon">created_<wbr>at</a>
395
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a>
403
396
  </li>
404
397
  <li class=" tsd-kind-property tsd-parent-kind-interface">
405
- <a href="endpointconfiguration.html#description" class="tsd-kind-icon">description</a>
398
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#compression" class="tsd-kind-icon">compression</a>
406
399
  </li>
407
400
  <li class=" tsd-kind-property tsd-parent-kind-interface">
408
- <a href="endpointconfiguration.html#id" class="tsd-kind-icon">id</a>
401
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#description" class="tsd-kind-icon">description</a>
409
402
  </li>
410
403
  <li class=" tsd-kind-property tsd-parent-kind-interface">
411
- <a href="endpointconfiguration.html#ip_policy" class="tsd-kind-icon">ip_<wbr>policy</a>
404
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#edgeId" class="tsd-kind-icon">edge<wbr>Id</a>
412
405
  </li>
413
406
  <li class=" tsd-kind-property tsd-parent-kind-interface">
414
- <a href="endpointconfiguration.html#logging" class="tsd-kind-icon">logging</a>
407
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#id" class="tsd-kind-icon">id</a>
415
408
  </li>
416
409
  <li class=" tsd-kind-property tsd-parent-kind-interface">
417
- <a href="endpointconfiguration.html#metadata" class="tsd-kind-icon">metadata</a>
410
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a>
418
411
  </li>
419
412
  <li class=" tsd-kind-property tsd-parent-kind-interface">
420
- <a href="endpointconfiguration.html#mutual_tls" class="tsd-kind-icon">mutual_<wbr>tls</a>
413
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#match" class="tsd-kind-icon">match</a>
421
414
  </li>
422
415
  <li class=" tsd-kind-property tsd-parent-kind-interface">
423
- <a href="endpointconfiguration.html#oauth" class="tsd-kind-icon">oauth</a>
416
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#matchType" class="tsd-kind-icon">match<wbr>Type</a>
424
417
  </li>
425
418
  <li class=" tsd-kind-property tsd-parent-kind-interface">
426
- <a href="endpointconfiguration.html#oidc" class="tsd-kind-icon">oidc</a>
419
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#metadata" class="tsd-kind-icon">metadata</a>
427
420
  </li>
428
421
  <li class=" tsd-kind-property tsd-parent-kind-interface">
429
- <a href="endpointconfiguration.html#request_headers" class="tsd-kind-icon">request_<wbr>headers</a>
422
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#oauth" class="tsd-kind-icon">oauth</a>
430
423
  </li>
431
424
  <li class=" tsd-kind-property tsd-parent-kind-interface">
432
- <a href="endpointconfiguration.html#response_headers" class="tsd-kind-icon">response_<wbr>headers</a>
425
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#oidc" class="tsd-kind-icon">oidc</a>
433
426
  </li>
434
427
  <li class=" tsd-kind-property tsd-parent-kind-interface">
435
- <a href="endpointconfiguration.html#saml" class="tsd-kind-icon">saml</a>
428
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a>
436
429
  </li>
437
430
  <li class=" tsd-kind-property tsd-parent-kind-interface">
438
- <a href="endpointconfiguration.html#tls_termination" class="tsd-kind-icon">tls_<wbr>termination</a>
431
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a>
439
432
  </li>
440
433
  <li class=" tsd-kind-property tsd-parent-kind-interface">
441
- <a href="endpointconfiguration.html#type" class="tsd-kind-icon">type</a>
434
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#saml" class="tsd-kind-icon">saml</a>
442
435
  </li>
443
436
  <li class=" tsd-kind-property tsd-parent-kind-interface">
444
- <a href="endpointconfiguration.html#uri" class="tsd-kind-icon">uri</a>
437
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a>
445
438
  </li>
446
439
  <li class=" tsd-kind-property tsd-parent-kind-interface">
447
- <a href="endpointconfiguration.html#webhook_validation" class="tsd-kind-icon">webhook_<wbr>validation</a>
440
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</a>
448
441
  </li>
449
442
  </ul>
450
443
  </li>
@@ -460,11 +453,11 @@
460
453
  <h2>Legend</h2>
461
454
  <div class="tsd-legend-group">
462
455
  <ul class="tsd-legend">
463
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
464
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
456
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
457
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
465
458
  </ul>
466
459
  <ul class="tsd-legend">
467
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
460
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
468
461
  </ul>
469
462
  </div>
470
463
  </div>