@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/{endpointsamlmutate.html → datatypes.EndpointSAMLMutate.html} RENAMED
@@ -55,7 +55,10 @@
55
55
  <a href="../modules.html">@ngrok/ngrok-api</a>
56
56
  </li>
57
57
  <li>
58
- <a href="endpointsamlmutate.html">EndpointSAMLMutate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointSAMLMutate.html">EndpointSAMLMutate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointSAMLMutate</h1>
@@ -80,15 +83,16 @@
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="endpointsamlmutate.html#allow_idp_initiated" class="tsd-kind-icon">allow_<wbr>idp_<wbr>initiated</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsamlmutate.html#authorized_groups" class="tsd-kind-icon">authorized_<wbr>groups</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsamlmutate.html#cookie_prefix" class="tsd-kind-icon">cookie_<wbr>prefix</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsamlmutate.html#enabled" class="tsd-kind-icon">enabled</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsamlmutate.html#force_authn" class="tsd-kind-icon">force_<wbr>authn</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsamlmutate.html#idp_metadata" class="tsd-kind-icon">idp_<wbr>metadata</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsamlmutate.html#inactivity_timeout" class="tsd-kind-icon">inactivity_<wbr>timeout</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsamlmutate.html#maximum_duration" class="tsd-kind-icon">maximum_<wbr>duration</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsamlmutate.html#options_passthrough" class="tsd-kind-icon">options_<wbr>passthrough</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#allowIdpInitiated" class="tsd-kind-icon">allow<wbr>Idp<wbr>Initiated</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#authorizedGroups" class="tsd-kind-icon">authorized<wbr>Groups</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#cookiePrefix" class="tsd-kind-icon">cookie<wbr>Prefix</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#enabled" class="tsd-kind-icon">enabled</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#forceAuthn" class="tsd-kind-icon">force<wbr>Authn</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#idpMetadata" class="tsd-kind-icon">idp<wbr>Metadata</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#inactivityTimeout" class="tsd-kind-icon">inactivity<wbr>Timeout</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#maximumDuration" class="tsd-kind-icon">maximum<wbr>Duration</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#nameidFormat" class="tsd-kind-icon">nameid<wbr>Format</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a></li>
92
96
  </ul>
93
97
  </section>
94
98
  </div>
@@ -97,27 +101,27 @@
97
101
  <section class="tsd-panel-group tsd-member-group ">
98
102
  <h2>Properties</h2>
99
103
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
100
- <a name="allow_idp_initiated" class="tsd-anchor"></a>
101
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> allow_<wbr>idp_<wbr>initiated</h3>
102
- <div class="tsd-signature tsd-kind-icon">allow_<wbr>idp_<wbr>initiated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
104
+ <a name="allowIdpInitiated" class="tsd-anchor"></a>
105
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr>Idp<wbr>Initiated</h3>
106
+ <div class="tsd-signature tsd-kind-icon">allow<wbr>Idp<wbr>Initiated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
103
107
  <aside class="tsd-sources">
104
108
  <ul>
105
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L712">types.ts:712</a></li>
109
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L643">datatypes.ts:643</a></li>
106
110
  </ul>
107
111
  </aside>
108
112
  <div class="tsd-comment tsd-typography">
109
113
  <div class="lead">
110
- <p>If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the RelayState parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed.</p>
114
+ <p>If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the <code>RelayState</code> parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed.</p>
111
115
  </div>
112
116
  </div>
113
117
  </section>
114
118
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
115
- <a name="authorized_groups" class="tsd-anchor"></a>
116
- <h3>authorized_<wbr>groups</h3>
117
- <div class="tsd-signature tsd-kind-icon">authorized_<wbr>groups<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
119
+ <a name="authorizedGroups" class="tsd-anchor"></a>
120
+ <h3>authorized<wbr>Groups</h3>
121
+ <div class="tsd-signature tsd-kind-icon">authorized<wbr>Groups<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
118
122
  <aside class="tsd-sources">
119
123
  <ul>
120
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L714">types.ts:714</a></li>
124
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L645">datatypes.ts:645</a></li>
121
125
  </ul>
122
126
  </aside>
123
127
  <div class="tsd-comment tsd-typography">
@@ -127,12 +131,12 @@
127
131
  </div>
128
132
  </section>
129
133
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
130
- <a name="cookie_prefix" class="tsd-anchor"></a>
131
- <h3>cookie_<wbr>prefix</h3>
132
- <div class="tsd-signature tsd-kind-icon">cookie_<wbr>prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
134
+ <a name="cookiePrefix" class="tsd-anchor"></a>
135
+ <h3>cookie<wbr>Prefix</h3>
136
+ <div class="tsd-signature tsd-kind-icon">cookie<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
133
137
  <aside class="tsd-sources">
134
138
  <ul>
135
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L702">types.ts:702</a></li>
139
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L633">datatypes.ts:633</a></li>
136
140
  </ul>
137
141
  </aside>
138
142
  <div class="tsd-comment tsd-typography">
@@ -147,22 +151,22 @@
147
151
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
148
152
  <aside class="tsd-sources">
149
153
  <ul>
150
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L698">types.ts:698</a></li>
154
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L629">datatypes.ts:629</a></li>
151
155
  </ul>
152
156
  </aside>
153
157
  <div class="tsd-comment tsd-typography">
154
158
  <div class="lead">
155
- <p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
159
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
156
160
  </div>
157
161
  </div>
158
162
  </section>
159
163
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
160
- <a name="force_authn" class="tsd-anchor"></a>
161
- <h3>force_<wbr>authn</h3>
162
- <div class="tsd-signature tsd-kind-icon">force_<wbr>authn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
164
+ <a name="forceAuthn" class="tsd-anchor"></a>
165
+ <h3>force<wbr>Authn</h3>
166
+ <div class="tsd-signature tsd-kind-icon">force<wbr>Authn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
163
167
  <aside class="tsd-sources">
164
168
  <ul>
165
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L710">types.ts:710</a></li>
169
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L641">datatypes.ts:641</a></li>
166
170
  </ul>
167
171
  </aside>
168
172
  <div class="tsd-comment tsd-typography">
@@ -172,12 +176,12 @@
172
176
  </div>
173
177
  </section>
174
178
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
175
- <a name="idp_metadata" class="tsd-anchor"></a>
176
- <h3>idp_<wbr>metadata</h3>
177
- <div class="tsd-signature tsd-kind-icon">idp_<wbr>metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
179
+ <a name="idpMetadata" class="tsd-anchor"></a>
180
+ <h3>idp<wbr>Metadata</h3>
181
+ <div class="tsd-signature tsd-kind-icon">idp<wbr>Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
178
182
  <aside class="tsd-sources">
179
183
  <ul>
180
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L708">types.ts:708</a></li>
184
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L639">datatypes.ts:639</a></li>
181
185
  </ul>
182
186
  </aside>
183
187
  <div class="tsd-comment tsd-typography">
@@ -187,12 +191,12 @@
187
191
  </div>
188
192
  </section>
189
193
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
190
- <a name="inactivity_timeout" class="tsd-anchor"></a>
191
- <h3>inactivity_<wbr>timeout</h3>
192
- <div class="tsd-signature tsd-kind-icon">inactivity_<wbr>timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
194
+ <a name="inactivityTimeout" class="tsd-anchor"></a>
195
+ <h3>inactivity<wbr>Timeout</h3>
196
+ <div class="tsd-signature tsd-kind-icon">inactivity<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
193
197
  <aside class="tsd-sources">
194
198
  <ul>
195
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L704">types.ts:704</a></li>
199
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L635">datatypes.ts:635</a></li>
196
200
  </ul>
197
201
  </aside>
198
202
  <div class="tsd-comment tsd-typography">
@@ -202,12 +206,12 @@
202
206
  </div>
203
207
  </section>
204
208
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
205
- <a name="maximum_duration" class="tsd-anchor"></a>
206
- <h3>maximum_<wbr>duration</h3>
207
- <div class="tsd-signature tsd-kind-icon">maximum_<wbr>duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
209
+ <a name="maximumDuration" class="tsd-anchor"></a>
210
+ <h3>maximum<wbr>Duration</h3>
211
+ <div class="tsd-signature tsd-kind-icon">maximum<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
208
212
  <aside class="tsd-sources">
209
213
  <ul>
210
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L706">types.ts:706</a></li>
214
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L637">datatypes.ts:637</a></li>
211
215
  </ul>
212
216
  </aside>
213
217
  <div class="tsd-comment tsd-typography">
@@ -217,12 +221,27 @@
217
221
  </div>
218
222
  </section>
219
223
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
220
- <a name="options_passthrough" class="tsd-anchor"></a>
221
- <h3>options_<wbr>passthrough</h3>
222
- <div class="tsd-signature tsd-kind-icon">options_<wbr>passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
224
+ <a name="nameidFormat" class="tsd-anchor"></a>
225
+ <h3>nameid<wbr>Format</h3>
226
+ <div class="tsd-signature tsd-kind-icon">nameid<wbr>Format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
223
227
  <aside class="tsd-sources">
224
228
  <ul>
225
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L700">types.ts:700</a></li>
229
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L647">datatypes.ts:647</a></li>
230
+ </ul>
231
+ </aside>
232
+ <div class="tsd-comment tsd-typography">
233
+ <div class="lead">
234
+ <p>Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of <code>urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</code> will be used. A subset of the allowed values enumerated by the SAML specification are supported.</p>
235
+ </div>
236
+ </div>
237
+ </section>
238
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
239
+ <a name="optionsPassthrough" class="tsd-anchor"></a>
240
+ <h3>options<wbr>Passthrough</h3>
241
+ <div class="tsd-signature tsd-kind-icon">options<wbr>Passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
242
+ <aside class="tsd-sources">
243
+ <ul>
244
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L631">datatypes.ts:631</a></li>
226
245
  </ul>
227
246
  </aside>
228
247
  <div class="tsd-comment tsd-typography">
@@ -237,7 +256,16 @@
237
256
  <nav class="tsd-navigation primary">
238
257
  <ul>
239
258
  <li class=" ">
240
- <a href="../modules.html">Exports</a>
259
+ <a href="../modules.html">Modules</a>
260
+ </li>
261
+ <li class=" tsd-kind-module">
262
+ <a href="../modules/client.html">client</a>
263
+ </li>
264
+ <li class="current tsd-kind-module">
265
+ <a href="../modules/datatypes.html">datatypes</a>
266
+ </li>
267
+ <li class=" tsd-kind-module">
268
+ <a href="../modules/services.html">services</a>
241
269
  </li>
242
270
  </ul>
243
271
  </nav>
@@ -245,35 +273,38 @@
245
273
  <ul class="before-current">
246
274
  </ul>
247
275
  <ul class="current">
248
- <li class="current tsd-kind-interface">
249
- <a href="endpointsamlmutate.html" class="tsd-kind-icon">EndpointSAMLMutate</a>
276
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
277
+ <a href="datatypes.EndpointSAMLMutate.html" class="tsd-kind-icon">EndpointSAMLMutate</a>
250
278
  <ul>
251
279
  <li class=" tsd-kind-property tsd-parent-kind-interface">
252
- <a href="endpointsamlmutate.html#allow_idp_initiated" class="tsd-kind-icon">allow_<wbr>idp_<wbr>initiated</a>
280
+ <a href="datatypes.EndpointSAMLMutate.html#allowIdpInitiated" class="tsd-kind-icon">allow<wbr>Idp<wbr>Initiated</a>
253
281
  </li>
254
282
  <li class=" tsd-kind-property tsd-parent-kind-interface">
255
- <a href="endpointsamlmutate.html#authorized_groups" class="tsd-kind-icon">authorized_<wbr>groups</a>
283
+ <a href="datatypes.EndpointSAMLMutate.html#authorizedGroups" class="tsd-kind-icon">authorized<wbr>Groups</a>
256
284
  </li>
257
285
  <li class=" tsd-kind-property tsd-parent-kind-interface">
258
- <a href="endpointsamlmutate.html#cookie_prefix" class="tsd-kind-icon">cookie_<wbr>prefix</a>
286
+ <a href="datatypes.EndpointSAMLMutate.html#cookiePrefix" class="tsd-kind-icon">cookie<wbr>Prefix</a>
259
287
  </li>
260
288
  <li class=" tsd-kind-property tsd-parent-kind-interface">
261
- <a href="endpointsamlmutate.html#enabled" class="tsd-kind-icon">enabled</a>
289
+ <a href="datatypes.EndpointSAMLMutate.html#enabled" class="tsd-kind-icon">enabled</a>
262
290
  </li>
263
291
  <li class=" tsd-kind-property tsd-parent-kind-interface">
264
- <a href="endpointsamlmutate.html#force_authn" class="tsd-kind-icon">force_<wbr>authn</a>
292
+ <a href="datatypes.EndpointSAMLMutate.html#forceAuthn" class="tsd-kind-icon">force<wbr>Authn</a>
265
293
  </li>
266
294
  <li class=" tsd-kind-property tsd-parent-kind-interface">
267
- <a href="endpointsamlmutate.html#idp_metadata" class="tsd-kind-icon">idp_<wbr>metadata</a>
295
+ <a href="datatypes.EndpointSAMLMutate.html#idpMetadata" class="tsd-kind-icon">idp<wbr>Metadata</a>
268
296
  </li>
269
297
  <li class=" tsd-kind-property tsd-parent-kind-interface">
270
- <a href="endpointsamlmutate.html#inactivity_timeout" class="tsd-kind-icon">inactivity_<wbr>timeout</a>
298
+ <a href="datatypes.EndpointSAMLMutate.html#inactivityTimeout" class="tsd-kind-icon">inactivity<wbr>Timeout</a>
271
299
  </li>
272
300
  <li class=" tsd-kind-property tsd-parent-kind-interface">
273
- <a href="endpointsamlmutate.html#maximum_duration" class="tsd-kind-icon">maximum_<wbr>duration</a>
301
+ <a href="datatypes.EndpointSAMLMutate.html#maximumDuration" class="tsd-kind-icon">maximum<wbr>Duration</a>
274
302
  </li>
275
303
  <li class=" tsd-kind-property tsd-parent-kind-interface">
276
- <a href="endpointsamlmutate.html#options_passthrough" class="tsd-kind-icon">options_<wbr>passthrough</a>
304
+ <a href="datatypes.EndpointSAMLMutate.html#nameidFormat" class="tsd-kind-icon">nameid<wbr>Format</a>
305
+ </li>
306
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
307
+ <a href="datatypes.EndpointSAMLMutate.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a>
277
308
  </li>
278
309
  </ul>
279
310
  </li>
@@ -289,11 +320,11 @@
289
320
  <h2>Legend</h2>
290
321
  <div class="tsd-legend-group">
291
322
  <ul class="tsd-legend">
292
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
293
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
323
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
324
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
294
325
  </ul>
295
326
  <ul class="tsd-legend">
296
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
327
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
297
328
  </ul>
298
329
  </div>
299
330
  </div>
package/docs/interfaces/{endpointtlstermination.html → datatypes.EndpointTLSTermination.html} RENAMED
@@ -55,7 +55,10 @@
55
55
  <a href="../modules.html">@ngrok/ngrok-api</a>
56
56
  </li>
57
57
  <li>
58
- <a href="endpointtlstermination.html">EndpointTLSTermination</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointTLSTermination.html">EndpointTLSTermination</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointTLSTermination</h1>
@@ -80,9 +83,9 @@
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="endpointtlstermination.html#enabled" class="tsd-kind-icon">enabled</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointtlstermination.html#min_version" class="tsd-kind-icon">min_<wbr>version</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointtlstermination.html#terminate_at" class="tsd-kind-icon">terminate_<wbr>at</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointTLSTermination.html#enabled" class="tsd-kind-icon">enabled</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointTLSTermination.html#minVersion" class="tsd-kind-icon">min<wbr>Version</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointTLSTermination.html#terminateAt" class="tsd-kind-icon">terminate<wbr>At</a></li>
86
89
  </ul>
87
90
  </section>
88
91
  </div>
@@ -96,42 +99,42 @@
96
99
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
97
100
  <aside class="tsd-sources">
98
101
  <ul>
99
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L512">types.ts:512</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L450">datatypes.ts:450</a></li>
100
103
  </ul>
101
104
  </aside>
102
105
  <div class="tsd-comment tsd-typography">
103
106
  <div class="lead">
104
- <p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
107
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
105
108
  </div>
106
109
  </div>
107
110
  </section>
108
111
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
109
- <a name="min_version" class="tsd-anchor"></a>
110
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> min_<wbr>version</h3>
111
- <div class="tsd-signature tsd-kind-icon">min_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
112
+ <a name="minVersion" class="tsd-anchor"></a>
113
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr>Version</h3>
114
+ <div class="tsd-signature tsd-kind-icon">min<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
112
115
  <aside class="tsd-sources">
113
116
  <ul>
114
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L516">types.ts:516</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L454">datatypes.ts:454</a></li>
115
118
  </ul>
116
119
  </aside>
117
120
  <div class="tsd-comment tsd-typography">
118
121
  <div class="lead">
119
- <p>The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.</p>
122
+ <p>The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if <code>terminate_at</code> is set to <code>upstream</code>.</p>
120
123
  </div>
121
124
  </div>
122
125
  </section>
123
126
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
124
- <a name="terminate_at" class="tsd-anchor"></a>
125
- <h3>terminate_<wbr>at</h3>
126
- <div class="tsd-signature tsd-kind-icon">terminate_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
127
+ <a name="terminateAt" class="tsd-anchor"></a>
128
+ <h3>terminate<wbr>At</h3>
129
+ <div class="tsd-signature tsd-kind-icon">terminate<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
127
130
  <aside class="tsd-sources">
128
131
  <ul>
129
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L514">types.ts:514</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L452">datatypes.ts:452</a></li>
130
133
  </ul>
131
134
  </aside>
132
135
  <div class="tsd-comment tsd-typography">
133
136
  <div class="lead">
134
- <p>edge if the ngrok edge should terminate TLS traffic, upstream if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if upstream is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.</p>
137
+ <p><code>edge</code> if the ngrok edge should terminate TLS traffic, <code>upstream</code> if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if <code>upstream</code> is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.</p>
135
138
  </div>
136
139
  </div>
137
140
  </section>
@@ -141,7 +144,16 @@
141
144
  <nav class="tsd-navigation primary">
142
145
  <ul>
143
146
  <li class=" ">
144
- <a href="../modules.html">Exports</a>
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>
145
157
  </li>
146
158
  </ul>
147
159
  </nav>
@@ -149,17 +161,17 @@
149
161
  <ul class="before-current">
150
162
  </ul>
151
163
  <ul class="current">
152
- <li class="current tsd-kind-interface">
153
- <a href="endpointtlstermination.html" class="tsd-kind-icon">EndpointTLSTermination</a>
164
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
165
+ <a href="datatypes.EndpointTLSTermination.html" class="tsd-kind-icon">EndpointTLSTermination</a>
154
166
  <ul>
155
167
  <li class=" tsd-kind-property tsd-parent-kind-interface">
156
- <a href="endpointtlstermination.html#enabled" class="tsd-kind-icon">enabled</a>
168
+ <a href="datatypes.EndpointTLSTermination.html#enabled" class="tsd-kind-icon">enabled</a>
157
169
  </li>
158
170
  <li class=" tsd-kind-property tsd-parent-kind-interface">
159
- <a href="endpointtlstermination.html#min_version" class="tsd-kind-icon">min_<wbr>version</a>
171
+ <a href="datatypes.EndpointTLSTermination.html#minVersion" class="tsd-kind-icon">min<wbr>Version</a>
160
172
  </li>
161
173
  <li class=" tsd-kind-property tsd-parent-kind-interface">
162
- <a href="endpointtlstermination.html#terminate_at" class="tsd-kind-icon">terminate_<wbr>at</a>
174
+ <a href="datatypes.EndpointTLSTermination.html#terminateAt" class="tsd-kind-icon">terminate<wbr>At</a>
163
175
  </li>
164
176
  </ul>
165
177
  </li>
@@ -175,11 +187,11 @@
175
187
  <h2>Legend</h2>
176
188
  <div class="tsd-legend-group">
177
189
  <ul class="tsd-legend">
178
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
179
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
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>
180
192
  </ul>
181
193
  <ul class="tsd-legend">
182
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
194
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
183
195
  </ul>
184
196
  </div>
185
197
  </div>
package/docs/interfaces/{endpointloggingmutate.html → datatypes.EndpointTLSTerminationAtEdge.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>EndpointLoggingMutate | @ngrok/ngrok-api</title>
6
+ <title>EndpointTLSTerminationAtEdge | @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="endpointloggingmutate.html">EndpointLoggingMutate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointTLSTerminationAtEdge.html">EndpointTLSTerminationAtEdge</a>
59
62
  </li>
60
63
  </ul>
61
- <h1>Interface EndpointLoggingMutate</h1>
64
+ <h1>Interface EndpointTLSTerminationAtEdge</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">EndpointLoggingMutate</span>
75
+ <span class="target">EndpointTLSTerminationAtEdge</span>
73
76
  </li>
74
77
  </ul>
75
78
  </section>
@@ -80,8 +83,8 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointloggingmutate.html#enabled" class="tsd-kind-icon">enabled</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointloggingmutate.html#event_stream_ids" class="tsd-kind-icon">event_<wbr>stream_<wbr>ids</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointTLSTerminationAtEdge.html#enabled" class="tsd-kind-icon">enabled</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointTLSTerminationAtEdge.html#minVersion" class="tsd-kind-icon">min<wbr>Version</a></li>
85
88
  </ul>
86
89
  </section>
87
90
  </div>
@@ -95,27 +98,27 @@
95
98
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
96
99
  <aside class="tsd-sources">
97
100
  <ul>
98
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L530">types.ts:530</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L459">datatypes.ts:459</a></li>
99
102
  </ul>
100
103
  </aside>
101
104
  <div class="tsd-comment tsd-typography">
102
105
  <div class="lead">
103
- <p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
106
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
104
107
  </div>
105
108
  </div>
106
109
  </section>
107
110
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
108
- <a name="event_stream_ids" class="tsd-anchor"></a>
109
- <h3>event_<wbr>stream_<wbr>ids</h3>
110
- <div class="tsd-signature tsd-kind-icon">event_<wbr>stream_<wbr>ids<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
111
+ <a name="minVersion" class="tsd-anchor"></a>
112
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr>Version</h3>
113
+ <div class="tsd-signature tsd-kind-icon">min<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
111
114
  <aside class="tsd-sources">
112
115
  <ul>
113
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L532">types.ts:532</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L461">datatypes.ts:461</a></li>
114
117
  </ul>
115
118
  </aside>
116
119
  <div class="tsd-comment tsd-typography">
117
120
  <div class="lead">
118
- <p>list of all EventStreams that will be used to configure and export this endpoint&#39;s logs</p>
121
+ <p>The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if <code>terminate_at</code> is set to <code>upstream</code>.</p>
119
122
  </div>
120
123
  </div>
121
124
  </section>
@@ -125,7 +128,16 @@
125
128
  <nav class="tsd-navigation primary">
126
129
  <ul>
127
130
  <li class=" ">
128
- <a href="../modules.html">Exports</a>
131
+ <a href="../modules.html">Modules</a>
132
+ </li>
133
+ <li class=" tsd-kind-module">
134
+ <a href="../modules/client.html">client</a>
135
+ </li>
136
+ <li class="current tsd-kind-module">
137
+ <a href="../modules/datatypes.html">datatypes</a>
138
+ </li>
139
+ <li class=" tsd-kind-module">
140
+ <a href="../modules/services.html">services</a>
129
141
  </li>
130
142
  </ul>
131
143
  </nav>
@@ -133,14 +145,14 @@
133
145
  <ul class="before-current">
134
146
  </ul>
135
147
  <ul class="current">
136
- <li class="current tsd-kind-interface">
137
- <a href="endpointloggingmutate.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Mutate</a>
148
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
149
+ <a href="datatypes.EndpointTLSTerminationAtEdge.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>AtEdge</a>
138
150
  <ul>
139
151
  <li class=" tsd-kind-property tsd-parent-kind-interface">
140
- <a href="endpointloggingmutate.html#enabled" class="tsd-kind-icon">enabled</a>
152
+ <a href="datatypes.EndpointTLSTerminationAtEdge.html#enabled" class="tsd-kind-icon">enabled</a>
141
153
  </li>
142
154
  <li class=" tsd-kind-property tsd-parent-kind-interface">
143
- <a href="endpointloggingmutate.html#event_stream_ids" class="tsd-kind-icon">event_<wbr>stream_<wbr>ids</a>
155
+ <a href="datatypes.EndpointTLSTerminationAtEdge.html#minVersion" class="tsd-kind-icon">min<wbr>Version</a>
144
156
  </li>
145
157
  </ul>
146
158
  </li>
@@ -156,11 +168,11 @@
156
168
  <h2>Legend</h2>
157
169
  <div class="tsd-legend-group">
158
170
  <ul class="tsd-legend">
159
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
160
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
171
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
172
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
161
173
  </ul>
162
174
  <ul class="tsd-legend">
163
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
175
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
164
176
  </ul>
165
177
  </div>
166
178
  </div>