@ngrok/ngrok-api 0.1.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (283) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +102 -31
  3. package/docs/CNAME +1 -0
  4. package/docs/assets/js/search.js +1 -1
  5. package/docs/classes/client.Ngrok.html +772 -0
  6. package/docs/classes/services.APIKeys.html +354 -0
  7. package/docs/classes/services.AbuseReports.html +261 -0
  8. package/docs/classes/services.AgentIngresses.html +343 -0
  9. package/docs/classes/services.CertificateAuthorities.html +354 -0
  10. package/docs/classes/services.Credentials.html +353 -0
  11. package/docs/classes/services.EdgeRouteBackendModule.html +270 -0
  12. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +270 -0
  13. package/docs/classes/services.EdgeRouteCompressionModule.html +270 -0
  14. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +270 -0
  15. package/docs/classes/services.EdgeRouteOAuthModule.html +270 -0
  16. package/docs/classes/services.EdgeRouteOIDCModule.html +270 -0
  17. package/docs/classes/services.EdgeRouteRequestHeadersModule.html +270 -0
  18. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +270 -0
  19. package/docs/classes/services.EdgeRouteSAMLModule.html +270 -0
  20. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +270 -0
  21. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +270 -0
  22. package/docs/classes/services.EdgesHTTPS.html +343 -0
  23. package/docs/classes/services.EdgesHTTPSRoutes.html +317 -0
  24. package/docs/classes/services.EdgesTCP.html +343 -0
  25. package/docs/classes/services.EdgesTLS.html +343 -0
  26. package/docs/classes/services.Endpoints.html +256 -0
  27. package/docs/classes/services.EventDestinations.html +343 -0
  28. package/docs/classes/services.EventSources.html +349 -0
  29. package/docs/classes/services.EventSubscriptions.html +343 -0
  30. package/docs/classes/services.FailoverBackends.html +353 -0
  31. package/docs/classes/services.HTTPResponseBackends.html +318 -0
  32. package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +270 -0
  33. package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +270 -0
  34. package/docs/classes/services.IPPolicies.html +353 -0
  35. package/docs/classes/services.IPPolicyRules.html +351 -0
  36. package/docs/classes/services.IPRestrictions.html +355 -0
  37. package/docs/classes/services.ReservedAddrs.html +352 -0
  38. package/docs/classes/services.ReservedDomains.html +417 -0
  39. package/docs/classes/services.SSHCertificateAuthorities.html +351 -0
  40. package/docs/classes/services.SSHCredentials.html +351 -0
  41. package/docs/classes/services.SSHHostCertificates.html +352 -0
  42. package/docs/classes/services.SSHUserCertificates.html +352 -0
  43. package/docs/classes/services.TCPEdgeBackendModule.html +270 -0
  44. package/docs/classes/services.TCPEdgeIPRestrictionModule.html +270 -0
  45. package/docs/classes/services.TLSCertificates.html +354 -0
  46. package/docs/classes/services.TLSEdgeBackendModule.html +270 -0
  47. package/docs/classes/services.TLSEdgeIPRestrictionModule.html +270 -0
  48. package/docs/classes/services.TLSEdgeMutualTLSModule.html +270 -0
  49. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +270 -0
  50. package/docs/classes/services.TunnelGroupBackends.html +351 -0
  51. package/docs/classes/services.TunnelSessions.html +352 -0
  52. package/docs/classes/services.Tunnels.html +255 -0
  53. package/docs/classes/services.WeightedBackends.html +353 -0
  54. package/docs/index.html +103 -546
  55. package/docs/interfaces/client.NgrokConfig.html +179 -0
  56. package/docs/interfaces/{apikey.html → datatypes.APIKey.html} +41 -29
  57. package/docs/interfaces/{apikeycreate.html → datatypes.APIKeyCreate.html} +25 -13
  58. package/docs/interfaces/{apikeylist.html → datatypes.APIKeyList.html} +32 -20
  59. package/docs/interfaces/{apikeyupdate.html → datatypes.APIKeyUpdate.html} +28 -16
  60. package/docs/interfaces/{awsauth.html → datatypes.AWSAuth.html} +27 -15
  61. package/docs/interfaces/{awscredentials.html → datatypes.AWSCredentials.html} +31 -19
  62. package/docs/interfaces/{awsrole.html → datatypes.AWSRole.html} +25 -13
  63. package/docs/interfaces/{abusereport.html → datatypes.AbuseReport.html} +45 -33
  64. package/docs/interfaces/{abusereportcreate.html → datatypes.AbuseReportCreate.html} +25 -13
  65. package/docs/interfaces/{abusereporthostname.html → datatypes.AbuseReportHostname.html} +26 -14
  66. package/docs/interfaces/datatypes.AgentIngress.html +300 -0
  67. package/docs/interfaces/{ipwhitelistentrycreate.html → datatypes.AgentIngressCreate.html} +37 -25
  68. package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
  69. package/docs/interfaces/{ipwhitelistentryupdate.html → datatypes.AgentIngressUpdate.html} +33 -21
  70. package/docs/interfaces/{certificateauthority.html → datatypes.CertificateAuthority.html} +73 -61
  71. package/docs/interfaces/{certificateauthoritycreate.html → datatypes.CertificateAuthorityCreate.html} +31 -19
  72. package/docs/interfaces/{certificateauthoritylist.html → datatypes.CertificateAuthorityList.html} +34 -22
  73. package/docs/interfaces/{certificateauthorityupdate.html → datatypes.CertificateAuthorityUpdate.html} +28 -16
  74. package/docs/interfaces/{credential.html → datatypes.Credential.html} +45 -33
  75. package/docs/interfaces/{credentialcreate.html → datatypes.CredentialCreate.html} +29 -17
  76. package/docs/interfaces/{credentiallist.html → datatypes.CredentialList.html} +32 -20
  77. package/docs/interfaces/{credentialupdate.html → datatypes.CredentialUpdate.html} +32 -20
  78. package/docs/interfaces/{endpointippolicyreplace.html → datatypes.EdgeBackendReplace.html} +29 -17
  79. package/docs/interfaces/{endpointbackendreplace.html → datatypes.EdgeIPRestrictionReplace.html} +29 -17
  80. package/docs/interfaces/{endpointresponseheadersreplace.html → datatypes.EdgeMutualTLSReplace.html} +29 -17
  81. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +190 -0
  82. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +190 -0
  83. package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +190 -0
  84. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +190 -0
  85. package/docs/interfaces/{reserveddomaincertnstarget.html → datatypes.EdgeRouteItem.html} +36 -24
  86. package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +190 -0
  87. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +190 -0
  88. package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +190 -0
  89. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +190 -0
  90. package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +190 -0
  91. package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +190 -0
  92. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +190 -0
  93. package/docs/interfaces/{endpointoauthreplace.html → datatypes.EdgeTLSTerminationAtEdgeReplace.html} +29 -17
  94. package/docs/interfaces/{endpointbasicauthreplace.html → datatypes.EdgeTLSTerminationReplace.html} +29 -17
  95. package/docs/interfaces/{empty.html → datatypes.Empty.html} +18 -7
  96. package/docs/interfaces/datatypes.Endpoint.html +395 -0
  97. package/docs/interfaces/{endpointbackend.html → datatypes.EndpointBackend.html} +27 -15
  98. package/docs/interfaces/{endpointlogging.html → datatypes.EndpointBackendMutate.html} +36 -24
  99. package/docs/interfaces/{endpointcircuitbreaker.html → datatypes.EndpointCircuitBreaker.html} +53 -41
  100. package/docs/interfaces/{endpointcompression.html → datatypes.EndpointCompression.html} +23 -11
  101. package/docs/interfaces/{endpointippolicy.html → datatypes.EndpointIPPolicy.html} +29 -17
  102. package/docs/interfaces/{endpointippolicymutate.html → datatypes.EndpointIPPolicyMutate.html} +29 -17
  103. package/docs/interfaces/datatypes.EndpointList.html +205 -0
  104. package/docs/interfaces/{endpointmutualtls.html → datatypes.EndpointMutualTLS.html} +29 -17
  105. package/docs/interfaces/{endpointmutualtlsmutate.html → datatypes.EndpointMutualTLSMutate.html} +29 -17
  106. package/docs/interfaces/{endpointoauth.html → datatypes.EndpointOAuth.html} +57 -45
  107. package/docs/interfaces/{endpointoauthfacebook.html → datatypes.EndpointOAuthFacebook.html} +48 -36
  108. package/docs/interfaces/{endpointoauthgithub.html → datatypes.EndpointOAuthGitHub.html} +55 -43
  109. package/docs/interfaces/{endpointoauthgoogle.html → datatypes.EndpointOAuthGoogle.html} +48 -36
  110. package/docs/interfaces/{endpointoauthmicrosoft.html → datatypes.EndpointOAuthMicrosoft.html} +48 -36
  111. package/docs/interfaces/{endpointoauthprovider.html → datatypes.EndpointOAuthProvider.html} +35 -23
  112. package/docs/interfaces/{endpointoidc.html → datatypes.EndpointOIDC.html} +65 -53
  113. package/docs/interfaces/{endpointrequestheaders.html → datatypes.EndpointRequestHeaders.html} +29 -17
  114. package/docs/interfaces/{endpointresponseheaders.html → datatypes.EndpointResponseHeaders.html} +29 -17
  115. package/docs/interfaces/{endpointsaml.html → datatypes.EndpointSAML.html} +121 -90
  116. package/docs/interfaces/{endpointsamlmutate.html → datatypes.EndpointSAMLMutate.html} +91 -60
  117. package/docs/interfaces/{endpointtlstermination.html → datatypes.EndpointTLSTermination.html} +37 -25
  118. package/docs/interfaces/{endpointloggingmutate.html → datatypes.EndpointTLSTerminationAtEdge.html} +33 -21
  119. package/docs/interfaces/{endpointwebhookvalidation.html → datatypes.EndpointWebhookValidation.html} +30 -18
  120. package/docs/interfaces/{staticbackendtls.html → datatypes.EndpointWebsocketTCPConverter.html} +27 -15
  121. package/docs/interfaces/{error.html → datatypes.Error.html} +37 -25
  122. package/docs/interfaces/{eventdestination.html → datatypes.EventDestination.html} +46 -34
  123. package/docs/interfaces/{eventdestinationcreate.html → datatypes.EventDestinationCreate.html} +34 -22
  124. package/docs/interfaces/{eventdestinationlist.html → datatypes.EventDestinationList.html} +34 -22
  125. package/docs/interfaces/{eventdestinationupdate.html → datatypes.EventDestinationUpdate.html} +37 -25
  126. package/docs/interfaces/{eventsource.html → datatypes.EventSource.html} +25 -13
  127. package/docs/interfaces/{eventsourcecreate.html → datatypes.EventSourceCreate.html} +28 -16
  128. package/docs/interfaces/{eventsourceitem.html → datatypes.EventSourceItem.html} +28 -16
  129. package/docs/interfaces/{eventsourcelist.html → datatypes.EventSourceList.html} +26 -14
  130. package/docs/interfaces/{eventsourcepaging.html → datatypes.EventSourcePaging.html} +25 -13
  131. package/docs/interfaces/{eventsourcereplace.html → datatypes.EventSourceReplace.html} +22 -10
  132. package/docs/interfaces/{eventsourceupdate.html → datatypes.EventSourceUpdate.html} +28 -16
  133. package/docs/interfaces/{eventsubscription.html → datatypes.EventSubscription.html} +45 -33
  134. package/docs/interfaces/{eventsubscriptioncreate.html → datatypes.EventSubscriptionCreate.html} +36 -24
  135. package/docs/interfaces/{eventsubscriptionlist.html → datatypes.EventSubscriptionList.html} +34 -22
  136. package/docs/interfaces/{eventsubscriptionupdate.html → datatypes.EventSubscriptionUpdate.html} +39 -27
  137. package/docs/interfaces/{eventtarget.html → datatypes.EventTarget.html} +33 -21
  138. package/docs/interfaces/{eventtargetcloudwatchlogs.html → datatypes.EventTargetCloudwatchLogs.html} +30 -18
  139. package/docs/interfaces/{eventtargetfirehose.html → datatypes.EventTargetFirehose.html} +30 -18
  140. package/docs/interfaces/{eventtargetkinesis.html → datatypes.EventTargetKinesis.html} +30 -18
  141. package/docs/interfaces/{staticbackend.html → datatypes.FailoverBackend.html} +52 -40
  142. package/docs/interfaces/{prioritybackendcreate.html → datatypes.FailoverBackendCreate.html} +31 -19
  143. package/docs/interfaces/{prioritybackendlist.html → datatypes.FailoverBackendList.html} +37 -25
  144. package/docs/interfaces/{prioritybackendupdate.html → datatypes.FailoverBackendUpdate.html} +34 -22
  145. package/docs/interfaces/datatypes.HTTPResponseBackend.html +295 -0
  146. package/docs/interfaces/{tunnelgroupbackend.html → datatypes.HTTPResponseBackendCreate.html} +53 -41
  147. package/docs/interfaces/{staticbackendlist.html → datatypes.HTTPResponseBackendList.html} +35 -38
  148. package/docs/interfaces/{tcpedge.html → datatypes.HTTPResponseBackendUpdate.html} +58 -65
  149. package/docs/interfaces/{eventstream.html → datatypes.HTTPSEdge.html} +78 -71
  150. package/docs/interfaces/{staticbackendupdate.html → datatypes.HTTPSEdgeCreate.html} +60 -48
  151. package/docs/interfaces/datatypes.HTTPSEdgeList.html +205 -0
  152. package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +509 -0
  153. package/docs/interfaces/{endpointconfigurationcreate.html → datatypes.HTTPSEdgeRouteCreate.html} +141 -110
  154. package/docs/interfaces/{endpointconfiguration.html → datatypes.HTTPSEdgeRouteUpdate.html} +138 -145
  155. package/docs/interfaces/{tlsedgeupdate.html → datatypes.HTTPSEdgeUpdate.html} +65 -43
  156. package/docs/interfaces/{ippolicy.html → datatypes.IPPolicy.html} +37 -44
  157. package/docs/interfaces/{ippolicycreate.html → datatypes.IPPolicyCreate.html} +25 -32
  158. package/docs/interfaces/{ippolicylist.html → datatypes.IPPolicyList.html} +34 -22
  159. package/docs/interfaces/{ippolicyrule.html → datatypes.IPPolicyRule.html} +65 -34
  160. package/docs/interfaces/{ippolicyrulecreate.html → datatypes.IPPolicyRuleCreate.html} +53 -22
  161. package/docs/interfaces/{ippolicyrulelist.html → datatypes.IPPolicyRuleList.html} +34 -22
  162. package/docs/interfaces/{ippolicyruleupdate.html → datatypes.IPPolicyRuleUpdate.html} +31 -19
  163. package/docs/interfaces/{ippolicyupdate.html → datatypes.IPPolicyUpdate.html} +28 -16
  164. package/docs/interfaces/{iprestriction.html → datatypes.IPRestriction.html} +50 -38
  165. package/docs/interfaces/{iprestrictioncreate.html → datatypes.IPRestrictionCreate.html} +38 -26
  166. package/docs/interfaces/{iprestrictionlist.html → datatypes.IPRestrictionList.html} +34 -22
  167. package/docs/interfaces/{iprestrictionupdate.html → datatypes.IPRestrictionUpdate.html} +37 -25
  168. package/docs/interfaces/{item.html → datatypes.Item.html} +22 -10
  169. package/docs/interfaces/{paging.html → datatypes.Paging.html} +28 -16
  170. package/docs/interfaces/{ref.html → datatypes.Ref.html} +25 -13
  171. package/docs/interfaces/{reservedaddr.html → datatypes.ReservedAddr.html} +43 -50
  172. package/docs/interfaces/{reservedaddrcreate.html → datatypes.ReservedAddrCreate.html} +28 -35
  173. package/docs/interfaces/{reservedaddrlist.html → datatypes.ReservedAddrList.html} +34 -22
  174. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +200 -0
  175. package/docs/interfaces/{reserveddomain.html → datatypes.ReservedDomain.html} +82 -89
  176. package/docs/interfaces/{reserveddomaincertjob.html → datatypes.ReservedDomainCertJob.html} +40 -47
  177. package/docs/interfaces/{reserveddomaincertpolicy.html → datatypes.ReservedDomainCertPolicy.html} +28 -16
  178. package/docs/interfaces/{reserveddomaincertstatus.html → datatypes.ReservedDomainCertStatus.html} +31 -19
  179. package/docs/interfaces/{reserveddomaincreate.html → datatypes.ReservedDomainCreate.html} +45 -71
  180. package/docs/interfaces/{reserveddomainlist.html → datatypes.ReservedDomainList.html} +34 -22
  181. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +238 -0
  182. package/docs/interfaces/{sshcertificateauthority.html → datatypes.SSHCertificateAuthority.html} +49 -37
  183. package/docs/interfaces/{sshcertificateauthoritycreate.html → datatypes.SSHCertificateAuthorityCreate.html} +45 -33
  184. package/docs/interfaces/{sshcertificateauthoritylist.html → datatypes.SSHCertificateAuthorityList.html} +34 -22
  185. package/docs/interfaces/{sshcertificateauthorityupdate.html → datatypes.SSHCertificateAuthorityUpdate.html} +28 -16
  186. package/docs/interfaces/{sshcredential.html → datatypes.SSHCredential.html} +47 -35
  187. package/docs/interfaces/{sshcredentialcreate.html → datatypes.SSHCredentialCreate.html} +35 -23
  188. package/docs/interfaces/{sshcredentiallist.html → datatypes.SSHCredentialList.html} +34 -22
  189. package/docs/interfaces/{sshcredentialupdate.html → datatypes.SSHCredentialUpdate.html} +32 -20
  190. package/docs/interfaces/{sshhostcertificate.html → datatypes.SSHHostCertificate.html} +76 -64
  191. package/docs/interfaces/{sshhostcertificatecreate.html → datatypes.SSHHostCertificateCreate.html} +53 -41
  192. package/docs/interfaces/{sshhostcertificatelist.html → datatypes.SSHHostCertificateList.html} +34 -22
  193. package/docs/interfaces/{sshhostcertificateupdate.html → datatypes.SSHHostCertificateUpdate.html} +28 -16
  194. package/docs/interfaces/{sshusercertificate.html → datatypes.SSHUserCertificate.html} +87 -75
  195. package/docs/interfaces/{sshusercertificatecreate.html → datatypes.SSHUserCertificateCreate.html} +64 -52
  196. package/docs/interfaces/{sshusercertificatelist.html → datatypes.SSHUserCertificateList.html} +34 -22
  197. package/docs/interfaces/{sshusercertificateupdate.html → datatypes.SSHUserCertificateUpdate.html} +28 -16
  198. package/docs/interfaces/{tlsedge.html → datatypes.TCPEdge.html} +69 -66
  199. package/docs/interfaces/{tlsedgecreate.html → datatypes.TCPEdgeCreate.html} +64 -42
  200. package/docs/interfaces/{endpointconfigurationlist.html → datatypes.TCPEdgeList.html} +40 -28
  201. package/docs/interfaces/{eventstreamupdate.html → datatypes.TCPEdgeUpdate.html} +60 -53
  202. package/docs/interfaces/{tlscertificate.html → datatypes.TLSCertificate.html} +134 -122
  203. package/docs/interfaces/{tlscertificatecreate.html → datatypes.TLSCertificateCreate.html} +39 -27
  204. package/docs/interfaces/{tlscertificatelist.html → datatypes.TLSCertificateList.html} +34 -22
  205. package/docs/interfaces/{tlscertificatesans.html → datatypes.TLSCertificateSANs.html} +28 -16
  206. package/docs/interfaces/{tlscertificateupdate.html → datatypes.TLSCertificateUpdate.html} +28 -16
  207. package/docs/interfaces/datatypes.TLSEdge.html +323 -0
  208. package/docs/interfaces/datatypes.TLSEdgeCreate.html +266 -0
  209. package/docs/interfaces/datatypes.TLSEdgeList.html +205 -0
  210. package/docs/interfaces/{reserveddomainupdate.html → datatypes.TLSEdgeUpdate.html} +83 -62
  211. package/docs/interfaces/datatypes.Tunnel.html +357 -0
  212. package/docs/interfaces/datatypes.TunnelGroupBackend.html +281 -0
  213. package/docs/interfaces/{tunnelgroupbackendcreate.html → datatypes.TunnelGroupBackendCreate.html} +28 -16
  214. package/docs/interfaces/{tunnelgroupbackendlist.html → datatypes.TunnelGroupBackendList.html} +32 -20
  215. package/docs/interfaces/{tunnelgroupbackendupdate.html → datatypes.TunnelGroupBackendUpdate.html} +31 -19
  216. package/docs/interfaces/{tunnellist.html → datatypes.TunnelList.html} +32 -20
  217. package/docs/interfaces/{tunnelsession.html → datatypes.TunnelSession.html} +57 -45
  218. package/docs/interfaces/{tunnelsessionlist.html → datatypes.TunnelSessionList.html} +34 -22
  219. package/docs/interfaces/{tunnelsessionsupdate.html → datatypes.TunnelSessionsUpdate.html} +22 -10
  220. package/docs/interfaces/{weightedbackend.html → datatypes.WeightedBackend.html} +56 -25
  221. package/docs/interfaces/{weightedbackendcreate.html → datatypes.WeightedBackendCreate.html} +28 -16
  222. package/docs/interfaces/{weightedbackendlist.html → datatypes.WeightedBackendList.html} +32 -20
  223. package/docs/interfaces/{weightedbackendupdate.html → datatypes.WeightedBackendUpdate.html} +31 -19
  224. package/docs/{interfaces/endpointbasicauth.html → modules/client.html} +38 -20
  225. package/docs/modules/datatypes.html +796 -0
  226. package/docs/modules/services.html +316 -0
  227. package/docs/modules.html +16 -690
  228. package/lib/client.d.ts +179 -0
  229. package/lib/client.d.ts.map +1 -0
  230. package/lib/client.js +126 -0
  231. package/lib/client.js.map +1 -0
  232. package/lib/{types.d.ts → datatypes.d.ts} +729 -660
  233. package/lib/datatypes.d.ts.map +1 -0
  234. package/lib/{types.js → datatypes.js} +1 -1
  235. package/lib/datatypes.js.map +1 -0
  236. package/lib/index.d.ts +2 -378
  237. package/lib/index.d.ts.map +1 -1
  238. package/lib/index.js +2 -2148
  239. package/lib/index.js.map +1 -1
  240. package/lib/services.d.ts +993 -0
  241. package/lib/services.d.ts.map +1 -0
  242. package/lib/services.js +3600 -0
  243. package/lib/services.js.map +1 -0
  244. package/lib/util.d.ts +5 -0
  245. package/lib/util.d.ts.map +1 -0
  246. package/lib/util.js +53 -0
  247. package/lib/util.js.map +1 -0
  248. package/package.json +2 -2
  249. package/src/client.ts +322 -0
  250. package/src/{types.ts → datatypes.ts} +760 -689
  251. package/src/index.ts +2 -1775
  252. package/src/services.ts +3380 -0
  253. package/src/util.ts +48 -0
  254. package/test/apikey.test.js +41 -30
  255. package/docs/classes/ngrok.html +0 -5028
  256. package/docs/interfaces/endpointbackendmutate.html +0 -119
  257. package/docs/interfaces/endpointcircuitbreakerreplace.html +0 -164
  258. package/docs/interfaces/endpointcompressionreplace.html +0 -164
  259. package/docs/interfaces/endpointconfigurationupdate.html +0 -421
  260. package/docs/interfaces/endpointloggingreplace.html +0 -164
  261. package/docs/interfaces/endpointmutualtlsreplace.html +0 -164
  262. package/docs/interfaces/endpointoidcreplace.html +0 -164
  263. package/docs/interfaces/endpointrequestheadersreplace.html +0 -164
  264. package/docs/interfaces/endpointsamlreplace.html +0 -164
  265. package/docs/interfaces/endpointtlsterminationreplace.html +0 -164
  266. package/docs/interfaces/endpointwebhookvalidationreplace.html +0 -164
  267. package/docs/interfaces/eventstreamcreate.html +0 -250
  268. package/docs/interfaces/eventstreamlist.html +0 -193
  269. package/docs/interfaces/eventtargetdebug.html +0 -119
  270. package/docs/interfaces/eventtargets3.html +0 -250
  271. package/docs/interfaces/ipwhitelistentry.html +0 -250
  272. package/docs/interfaces/ipwhitelistentrylist.html +0 -193
  273. package/docs/interfaces/prioritybackend.html +0 -231
  274. package/docs/interfaces/reservedaddrupdate.html +0 -207
  275. package/docs/interfaces/rootresponse.html +0 -164
  276. package/docs/interfaces/sentevent.html +0 -150
  277. package/docs/interfaces/staticbackendcreate.html +0 -212
  278. package/docs/interfaces/tcpedgecreate.html +0 -188
  279. package/docs/interfaces/tcpedgeupdate.html +0 -207
  280. package/docs/interfaces/tunnel.html +0 -269
  281. package/lib/types.d.ts.map +0 -1
  282. package/lib/types.js.map +0 -1
  283. package/test/endpointConfigurations.test.js +0 -63
package/docs/interfaces/datatypes.TLSEdgeList.html ADDED
@@ -0,0 +1,205 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>TLSEdgeList | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.TLSEdgeList.html">TLSEdgeList</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface TLSEdgeList</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">TLSEdgeList</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeList.html#tlsEdges" class="tsd-kind-icon">tls<wbr>Edges</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeList.html#uri" class="tsd-kind-icon">uri</a></li>
89
+ </ul>
90
+ </section>
91
+ </div>
92
+ </section>
93
+ </section>
94
+ <section class="tsd-panel-group tsd-member-group ">
95
+ <h2>Properties</h2>
96
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
97
+ <a name="nextPageUri" class="tsd-anchor"></a>
98
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> next<wbr>Page<wbr>Uri</h3>
99
+ <div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
+ <aside class="tsd-sources">
101
+ <ul>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1015">datatypes.ts:1015</a></li>
103
+ </ul>
104
+ </aside>
105
+ <div class="tsd-comment tsd-typography">
106
+ <div class="lead">
107
+ <p>URI of the next page, or null if there is no next page</p>
108
+ </div>
109
+ </div>
110
+ </section>
111
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
112
+ <a name="tlsEdges" class="tsd-anchor"></a>
113
+ <h3>tls<wbr>Edges</h3>
114
+ <div class="tsd-signature tsd-kind-icon">tls<wbr>Edges<span class="tsd-signature-symbol">:</span> <a href="datatypes.TLSEdge.html" class="tsd-signature-type" data-tsd-kind="Interface">TLSEdge</a><span class="tsd-signature-symbol">[]</span></div>
115
+ <aside class="tsd-sources">
116
+ <ul>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1011">datatypes.ts:1011</a></li>
118
+ </ul>
119
+ </aside>
120
+ <div class="tsd-comment tsd-typography">
121
+ <div class="lead">
122
+ <p>the list of all TLS Edges on this account</p>
123
+ </div>
124
+ </div>
125
+ </section>
126
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
127
+ <a name="uri" class="tsd-anchor"></a>
128
+ <h3>uri</h3>
129
+ <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130
+ <aside class="tsd-sources">
131
+ <ul>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1013">datatypes.ts:1013</a></li>
133
+ </ul>
134
+ </aside>
135
+ <div class="tsd-comment tsd-typography">
136
+ <div class="lead">
137
+ <p>URI of the TLS Edge list API resource</p>
138
+ </div>
139
+ </div>
140
+ </section>
141
+ </section>
142
+ </div>
143
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
144
+ <nav class="tsd-navigation primary">
145
+ <ul>
146
+ <li class=" ">
147
+ <a href="../modules.html">Modules</a>
148
+ </li>
149
+ <li class=" tsd-kind-module">
150
+ <a href="../modules/client.html">client</a>
151
+ </li>
152
+ <li class="current tsd-kind-module">
153
+ <a href="../modules/datatypes.html">datatypes</a>
154
+ </li>
155
+ <li class=" tsd-kind-module">
156
+ <a href="../modules/services.html">services</a>
157
+ </li>
158
+ </ul>
159
+ </nav>
160
+ <nav class="tsd-navigation secondary menu-sticky">
161
+ <ul class="before-current">
162
+ </ul>
163
+ <ul class="current">
164
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
165
+ <a href="datatypes.TLSEdgeList.html" class="tsd-kind-icon">TLSEdge<wbr>List</a>
166
+ <ul>
167
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
168
+ <a href="datatypes.TLSEdgeList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a>
169
+ </li>
170
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
171
+ <a href="datatypes.TLSEdgeList.html#tlsEdges" class="tsd-kind-icon">tls<wbr>Edges</a>
172
+ </li>
173
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
174
+ <a href="datatypes.TLSEdgeList.html#uri" class="tsd-kind-icon">uri</a>
175
+ </li>
176
+ </ul>
177
+ </li>
178
+ </ul>
179
+ <ul class="after-current">
180
+ </ul>
181
+ </nav>
182
+ </div>
183
+ </div>
184
+ </div>
185
+ <footer class="with-border-bottom">
186
+ <div class="container">
187
+ <h2>Legend</h2>
188
+ <div class="tsd-legend-group">
189
+ <ul class="tsd-legend">
190
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
191
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
192
+ </ul>
193
+ <ul class="tsd-legend">
194
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
195
+ </ul>
196
+ </div>
197
+ </div>
198
+ </footer>
199
+ <div class="container tsd-generator">
200
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
201
+ </div>
202
+ <div class="overlay"></div>
203
+ <script src="../assets/js/main.js"></script>
204
+ </body>
205
+ </html>
package/docs/interfaces/{reserveddomainupdate.html → datatypes.TLSEdgeUpdate.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>ReservedDomainUpdate | @ngrok/ngrok-api</title>
6
+ <title>TLSEdgeUpdate | @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="reserveddomainupdate.html">ReservedDomainUpdate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.TLSEdgeUpdate.html">TLSEdgeUpdate</a>
59
62
  </li>
60
63
  </ul>
61
- <h1>Interface ReservedDomainUpdate</h1>
64
+ <h1>Interface TLSEdgeUpdate</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">ReservedDomainUpdate</span>
75
+ <span class="target">TLSEdgeUpdate</span>
73
76
  </li>
74
77
  </ul>
75
78
  </section>
@@ -80,13 +83,14 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomainupdate.html#certificate_id" class="tsd-kind-icon">certificate_<wbr>id</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomainupdate.html#certificate_management_policy" class="tsd-kind-icon">certificate_<wbr>management_<wbr>policy</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomainupdate.html#description" class="tsd-kind-icon">description</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomainupdate.html#http_endpoint_configuration_id" class="tsd-kind-icon">http_<wbr>endpoint_<wbr>configuration_<wbr>id</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomainupdate.html#https_endpoint_configuration_id" class="tsd-kind-icon">https_<wbr>endpoint_<wbr>configuration_<wbr>id</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomainupdate.html#id" class="tsd-kind-icon">id</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomainupdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeUpdate.html#backend" class="tsd-kind-icon">backend</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeUpdate.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeUpdate.html#hostports" class="tsd-kind-icon">hostports</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeUpdate.html#id" class="tsd-kind-icon">id</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeUpdate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeUpdate.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeUpdate.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a></li>
90
94
  </ul>
91
95
  </section>
92
96
  </div>
@@ -95,32 +99,17 @@
95
99
  <section class="tsd-panel-group tsd-member-group ">
96
100
  <h2>Properties</h2>
97
101
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
98
- <a name="certificate_id" class="tsd-anchor"></a>
99
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate_<wbr>id</h3>
100
- <div class="tsd-signature tsd-kind-icon">certificate_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
102
+ <a name="backend" class="tsd-anchor"></a>
103
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> backend</h3>
104
+ <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>
101
105
  <aside class="tsd-sources">
102
106
  <ul>
103
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1429">types.ts:1429</a></li>
107
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1042">datatypes.ts:1042</a></li>
104
108
  </ul>
105
109
  </aside>
106
110
  <div class="tsd-comment tsd-typography">
107
111
  <div class="lead">
108
- <p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.</p>
109
- </div>
110
- </div>
111
- </section>
112
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
113
- <a name="certificate_management_policy" class="tsd-anchor"></a>
114
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate_<wbr>management_<wbr>policy</h3>
115
- <div class="tsd-signature tsd-kind-icon">certificate_<wbr>management_<wbr>policy<span class="tsd-signature-symbol">:</span> <a href="reserveddomaincertpolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomainCertPolicy</a></div>
116
- <aside class="tsd-sources">
117
- <ul>
118
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1431">types.ts:1431</a></li>
119
- </ul>
120
- </aside>
121
- <div class="tsd-comment tsd-typography">
122
- <div class="lead">
123
- <p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id.</p>
112
+ <p>edge modules</p>
124
113
  </div>
125
114
  </div>
126
115
  </section>
@@ -130,52 +119,52 @@
130
119
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
131
120
  <aside class="tsd-sources">
132
121
  <ul>
133
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1421">types.ts:1421</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1036">datatypes.ts:1036</a></li>
134
123
  </ul>
135
124
  </aside>
136
125
  <div class="tsd-comment tsd-typography">
137
126
  <div class="lead">
138
- <p>human-readable description of what this reserved domain will be used for</p>
127
+ <p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
139
128
  </div>
140
129
  </div>
141
130
  </section>
142
131
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
143
- <a name="http_endpoint_configuration_id" class="tsd-anchor"></a>
144
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> http_<wbr>endpoint_<wbr>configuration_<wbr>id</h3>
145
- <div class="tsd-signature tsd-kind-icon">http_<wbr>endpoint_<wbr>configuration_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
132
+ <a name="hostports" class="tsd-anchor"></a>
133
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> hostports</h3>
134
+ <div class="tsd-signature tsd-kind-icon">hostports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
146
135
  <aside class="tsd-sources">
147
136
  <ul>
148
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1425">types.ts:1425</a></li>
137
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1040">datatypes.ts:1040</a></li>
149
138
  </ul>
150
139
  </aside>
151
140
  <div class="tsd-comment tsd-typography">
152
141
  <div class="lead">
153
- <p>ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p>
142
+ <p>hostports served by this edge</p>
154
143
  </div>
155
144
  </div>
156
145
  </section>
157
146
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
158
- <a name="https_endpoint_configuration_id" class="tsd-anchor"></a>
159
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> https_<wbr>endpoint_<wbr>configuration_<wbr>id</h3>
160
- <div class="tsd-signature tsd-kind-icon">https_<wbr>endpoint_<wbr>configuration_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
147
+ <a name="id" class="tsd-anchor"></a>
148
+ <h3>id</h3>
149
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
161
150
  <aside class="tsd-sources">
162
151
  <ul>
163
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1427">types.ts:1427</a></li>
152
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1034">datatypes.ts:1034</a></li>
164
153
  </ul>
165
154
  </aside>
166
155
  <div class="tsd-comment tsd-typography">
167
156
  <div class="lead">
168
- <p>ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p>
157
+ <p>unique identifier of this edge</p>
169
158
  </div>
170
159
  </div>
171
160
  </section>
172
161
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
173
- <a name="id" class="tsd-anchor"></a>
174
- <h3>id</h3>
175
- <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
162
+ <a name="ipRestriction" class="tsd-anchor"></a>
163
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip<wbr>Restriction</h3>
164
+ <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>
176
165
  <aside class="tsd-sources">
177
166
  <ul>
178
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1419">types.ts:1419</a></li>
167
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1043">datatypes.ts:1043</a></li>
179
168
  </ul>
180
169
  </aside>
181
170
  </section>
@@ -185,22 +174,51 @@
185
174
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
186
175
  <aside class="tsd-sources">
187
176
  <ul>
188
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1423">types.ts:1423</a></li>
177
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1038">datatypes.ts:1038</a></li>
189
178
  </ul>
190
179
  </aside>
191
180
  <div class="tsd-comment tsd-typography">
192
181
  <div class="lead">
193
- <p>arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</p>
182
+ <p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
194
183
  </div>
195
184
  </div>
196
185
  </section>
186
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
187
+ <a name="mutualTls" class="tsd-anchor"></a>
188
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> mutual<wbr>Tls</h3>
189
+ <div class="tsd-signature tsd-kind-icon">mutual<wbr>Tls<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointMutualTLSMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLSMutate</a></div>
190
+ <aside class="tsd-sources">
191
+ <ul>
192
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1044">datatypes.ts:1044</a></li>
193
+ </ul>
194
+ </aside>
195
+ </section>
196
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
197
+ <a name="tlsTermination" class="tsd-anchor"></a>
198
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> tls<wbr>Termination</h3>
199
+ <div class="tsd-signature tsd-kind-icon">tls<wbr>Termination<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</a></div>
200
+ <aside class="tsd-sources">
201
+ <ul>
202
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1045">datatypes.ts:1045</a></li>
203
+ </ul>
204
+ </aside>
205
+ </section>
197
206
  </section>
198
207
  </div>
199
208
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
200
209
  <nav class="tsd-navigation primary">
201
210
  <ul>
202
211
  <li class=" ">
203
- <a href="../modules.html">Exports</a>
212
+ <a href="../modules.html">Modules</a>
213
+ </li>
214
+ <li class=" tsd-kind-module">
215
+ <a href="../modules/client.html">client</a>
216
+ </li>
217
+ <li class="current tsd-kind-module">
218
+ <a href="../modules/datatypes.html">datatypes</a>
219
+ </li>
220
+ <li class=" tsd-kind-module">
221
+ <a href="../modules/services.html">services</a>
204
222
  </li>
205
223
  </ul>
206
224
  </nav>
@@ -208,29 +226,32 @@
208
226
  <ul class="before-current">
209
227
  </ul>
210
228
  <ul class="current">
211
- <li class="current tsd-kind-interface">
212
- <a href="reserveddomainupdate.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Update</a>
229
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
230
+ <a href="datatypes.TLSEdgeUpdate.html" class="tsd-kind-icon">TLSEdge<wbr>Update</a>
213
231
  <ul>
214
232
  <li class=" tsd-kind-property tsd-parent-kind-interface">
215
- <a href="reserveddomainupdate.html#certificate_id" class="tsd-kind-icon">certificate_<wbr>id</a>
233
+ <a href="datatypes.TLSEdgeUpdate.html#backend" class="tsd-kind-icon">backend</a>
216
234
  </li>
217
235
  <li class=" tsd-kind-property tsd-parent-kind-interface">
218
- <a href="reserveddomainupdate.html#certificate_management_policy" class="tsd-kind-icon">certificate_<wbr>management_<wbr>policy</a>
236
+ <a href="datatypes.TLSEdgeUpdate.html#description" class="tsd-kind-icon">description</a>
219
237
  </li>
220
238
  <li class=" tsd-kind-property tsd-parent-kind-interface">
221
- <a href="reserveddomainupdate.html#description" class="tsd-kind-icon">description</a>
239
+ <a href="datatypes.TLSEdgeUpdate.html#hostports" class="tsd-kind-icon">hostports</a>
222
240
  </li>
223
241
  <li class=" tsd-kind-property tsd-parent-kind-interface">
224
- <a href="reserveddomainupdate.html#http_endpoint_configuration_id" class="tsd-kind-icon">http_<wbr>endpoint_<wbr>configuration_<wbr>id</a>
242
+ <a href="datatypes.TLSEdgeUpdate.html#id" class="tsd-kind-icon">id</a>
225
243
  </li>
226
244
  <li class=" tsd-kind-property tsd-parent-kind-interface">
227
- <a href="reserveddomainupdate.html#https_endpoint_configuration_id" class="tsd-kind-icon">https_<wbr>endpoint_<wbr>configuration_<wbr>id</a>
245
+ <a href="datatypes.TLSEdgeUpdate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a>
228
246
  </li>
229
247
  <li class=" tsd-kind-property tsd-parent-kind-interface">
230
- <a href="reserveddomainupdate.html#id" class="tsd-kind-icon">id</a>
248
+ <a href="datatypes.TLSEdgeUpdate.html#metadata" class="tsd-kind-icon">metadata</a>
231
249
  </li>
232
250
  <li class=" tsd-kind-property tsd-parent-kind-interface">
233
- <a href="reserveddomainupdate.html#metadata" class="tsd-kind-icon">metadata</a>
251
+ <a href="datatypes.TLSEdgeUpdate.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a>
252
+ </li>
253
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
254
+ <a href="datatypes.TLSEdgeUpdate.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a>
234
255
  </li>
235
256
  </ul>
236
257
  </li>
@@ -246,11 +267,11 @@
246
267
  <h2>Legend</h2>
247
268
  <div class="tsd-legend-group">
248
269
  <ul class="tsd-legend">
249
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
250
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
270
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
271
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
251
272
  </ul>
252
273
  <ul class="tsd-legend">
253
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
274
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
254
275
  </ul>
255
276
  </div>
256
277
  </div>