@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/{endpointresponseheaders.html → datatypes.EndpointResponseHeaders.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="endpointresponseheaders.html">EndpointResponseHeaders</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointResponseHeaders.html">EndpointResponseHeaders</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointResponseHeaders</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="endpointresponseheaders.html#add" class="tsd-kind-icon">add</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointresponseheaders.html#enabled" class="tsd-kind-icon">enabled</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointresponseheaders.html#remove" class="tsd-kind-icon">remove</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointResponseHeaders.html#add" class="tsd-kind-icon">add</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointResponseHeaders.html#enabled" class="tsd-kind-icon">enabled</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointResponseHeaders.html#remove" class="tsd-kind-icon">remove</a></li>
86
89
  </ul>
87
90
  </section>
88
91
  </div>
@@ -96,7 +99,7 @@
96
99
  <div class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</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#L548">types.ts:548</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L477">datatypes.ts:477</a></li>
100
103
  </ul>
101
104
  </aside>
102
105
  <div class="tsd-comment tsd-typography">
@@ -111,12 +114,12 @@
111
114
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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#L546">types.ts:546</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L475">datatypes.ts:475</a></li>
115
118
  </ul>
116
119
  </aside>
117
120
  <div class="tsd-comment tsd-typography">
118
121
  <div class="lead">
119
- <p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
122
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
120
123
  </div>
121
124
  </div>
122
125
  </section>
@@ -126,7 +129,7 @@
126
129
  <div class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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#L550">types.ts:550</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L479">datatypes.ts:479</a></li>
130
133
  </ul>
131
134
  </aside>
132
135
  <div class="tsd-comment tsd-typography">
@@ -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="endpointresponseheaders.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers</a>
164
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
165
+ <a href="datatypes.EndpointResponseHeaders.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers</a>
154
166
  <ul>
155
167
  <li class=" tsd-kind-property tsd-parent-kind-interface">
156
- <a href="endpointresponseheaders.html#add" class="tsd-kind-icon">add</a>
168
+ <a href="datatypes.EndpointResponseHeaders.html#add" class="tsd-kind-icon">add</a>
157
169
  </li>
158
170
  <li class=" tsd-kind-property tsd-parent-kind-interface">
159
- <a href="endpointresponseheaders.html#enabled" class="tsd-kind-icon">enabled</a>
171
+ <a href="datatypes.EndpointResponseHeaders.html#enabled" class="tsd-kind-icon">enabled</a>
160
172
  </li>
161
173
  <li class=" tsd-kind-property tsd-parent-kind-interface">
162
- <a href="endpointresponseheaders.html#remove" class="tsd-kind-icon">remove</a>
174
+ <a href="datatypes.EndpointResponseHeaders.html#remove" class="tsd-kind-icon">remove</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/{endpointsaml.html → datatypes.EndpointSAML.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="endpointsaml.html">EndpointSAML</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointSAML.html">EndpointSAML</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointSAML</h1>
@@ -80,20 +83,21 @@
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="endpointsaml.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="endpointsaml.html#assertion_consumer_service_url" class="tsd-kind-icon">assertion_<wbr>consumer_<wbr>service_<wbr>url</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsaml.html#authorized_groups" class="tsd-kind-icon">authorized_<wbr>groups</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsaml.html#cookie_prefix" class="tsd-kind-icon">cookie_<wbr>prefix</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsaml.html#enabled" class="tsd-kind-icon">enabled</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsaml.html#entity_id" class="tsd-kind-icon">entity_<wbr>id</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsaml.html#force_authn" class="tsd-kind-icon">force_<wbr>authn</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsaml.html#idp_metadata" class="tsd-kind-icon">idp_<wbr>metadata</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsaml.html#inactivity_timeout" class="tsd-kind-icon">inactivity_<wbr>timeout</a></li>
92
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsaml.html#maximum_duration" class="tsd-kind-icon">maximum_<wbr>duration</a></li>
93
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsaml.html#metadata_url" class="tsd-kind-icon">metadata_<wbr>url</a></li>
94
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsaml.html#options_passthrough" class="tsd-kind-icon">options_<wbr>passthrough</a></li>
95
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsaml.html#request_signing_certificate_pem" class="tsd-kind-icon">request_<wbr>signing_<wbr>certificate_<wbr>pem</a></li>
96
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointsaml.html#single_logout_url" class="tsd-kind-icon">single_<wbr>logout_<wbr>url</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.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.EndpointSAML.html#assertionConsumerServiceUrl" class="tsd-kind-icon">assertion<wbr>Consumer<wbr>Service<wbr>Url</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#authorizedGroups" class="tsd-kind-icon">authorized<wbr>Groups</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#cookiePrefix" class="tsd-kind-icon">cookie<wbr>Prefix</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#enabled" class="tsd-kind-icon">enabled</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#entityId" class="tsd-kind-icon">entity<wbr>Id</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#forceAuthn" class="tsd-kind-icon">force<wbr>Authn</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#idpMetadata" class="tsd-kind-icon">idp<wbr>Metadata</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#inactivityTimeout" class="tsd-kind-icon">inactivity<wbr>Timeout</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#maximumDuration" class="tsd-kind-icon">maximum<wbr>Duration</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#metadataUrl" class="tsd-kind-icon">metadata<wbr>Url</a></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#nameidFormat" class="tsd-kind-icon">nameid<wbr>Format</a></li>
98
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a></li>
99
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#requestSigningCertificatePem" class="tsd-kind-icon">request<wbr>Signing<wbr>Certificate<wbr>Pem</a></li>
100
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#singleLogoutUrl" class="tsd-kind-icon">single<wbr>Logout<wbr>Url</a></li>
97
101
  </ul>
98
102
  </section>
99
103
  </div>
@@ -102,27 +106,27 @@
102
106
  <section class="tsd-panel-group tsd-member-group ">
103
107
  <h2>Properties</h2>
104
108
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
105
- <a name="allow_idp_initiated" class="tsd-anchor"></a>
106
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> allow_<wbr>idp_<wbr>initiated</h3>
107
- <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>
109
+ <a name="allowIdpInitiated" class="tsd-anchor"></a>
110
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr>Idp<wbr>Initiated</h3>
111
+ <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>
108
112
  <aside class="tsd-sources">
109
113
  <ul>
110
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L681">types.ts:681</a></li>
114
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L610">datatypes.ts:610</a></li>
111
115
  </ul>
112
116
  </aside>
113
117
  <div class="tsd-comment tsd-typography">
114
118
  <div class="lead">
115
- <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>
119
+ <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>
116
120
  </div>
117
121
  </div>
118
122
  </section>
119
123
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
120
- <a name="assertion_consumer_service_url" class="tsd-anchor"></a>
121
- <h3>assertion_<wbr>consumer_<wbr>service_<wbr>url</h3>
122
- <div class="tsd-signature tsd-kind-icon">assertion_<wbr>consumer_<wbr>service_<wbr>url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
124
+ <a name="assertionConsumerServiceUrl" class="tsd-anchor"></a>
125
+ <h3>assertion<wbr>Consumer<wbr>Service<wbr>Url</h3>
126
+ <div class="tsd-signature tsd-kind-icon">assertion<wbr>Consumer<wbr>Service<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
123
127
  <aside class="tsd-sources">
124
128
  <ul>
125
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L687">types.ts:687</a></li>
129
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L616">datatypes.ts:616</a></li>
126
130
  </ul>
127
131
  </aside>
128
132
  <div class="tsd-comment tsd-typography">
@@ -132,12 +136,12 @@
132
136
  </div>
133
137
  </section>
134
138
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
135
- <a name="authorized_groups" class="tsd-anchor"></a>
136
- <h3>authorized_<wbr>groups</h3>
137
- <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>
139
+ <a name="authorizedGroups" class="tsd-anchor"></a>
140
+ <h3>authorized<wbr>Groups</h3>
141
+ <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>
138
142
  <aside class="tsd-sources">
139
143
  <ul>
140
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L683">types.ts:683</a></li>
144
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L612">datatypes.ts:612</a></li>
141
145
  </ul>
142
146
  </aside>
143
147
  <div class="tsd-comment tsd-typography">
@@ -147,12 +151,12 @@
147
151
  </div>
148
152
  </section>
149
153
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
150
- <a name="cookie_prefix" class="tsd-anchor"></a>
151
- <h3>cookie_<wbr>prefix</h3>
152
- <div class="tsd-signature tsd-kind-icon">cookie_<wbr>prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
154
+ <a name="cookiePrefix" class="tsd-anchor"></a>
155
+ <h3>cookie<wbr>Prefix</h3>
156
+ <div class="tsd-signature tsd-kind-icon">cookie<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
153
157
  <aside class="tsd-sources">
154
158
  <ul>
155
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L671">types.ts:671</a></li>
159
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L600">datatypes.ts:600</a></li>
156
160
  </ul>
157
161
  </aside>
158
162
  <div class="tsd-comment tsd-typography">
@@ -167,22 +171,22 @@
167
171
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
168
172
  <aside class="tsd-sources">
169
173
  <ul>
170
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L667">types.ts:667</a></li>
174
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L596">datatypes.ts:596</a></li>
171
175
  </ul>
172
176
  </aside>
173
177
  <div class="tsd-comment tsd-typography">
174
178
  <div class="lead">
175
- <p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
179
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
176
180
  </div>
177
181
  </div>
178
182
  </section>
179
183
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
180
- <a name="entity_id" class="tsd-anchor"></a>
181
- <h3>entity_<wbr>id</h3>
182
- <div class="tsd-signature tsd-kind-icon">entity_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
184
+ <a name="entityId" class="tsd-anchor"></a>
185
+ <h3>entity<wbr>Id</h3>
186
+ <div class="tsd-signature tsd-kind-icon">entity<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
183
187
  <aside class="tsd-sources">
184
188
  <ul>
185
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L685">types.ts:685</a></li>
189
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L614">datatypes.ts:614</a></li>
186
190
  </ul>
187
191
  </aside>
188
192
  <div class="tsd-comment tsd-typography">
@@ -192,12 +196,12 @@
192
196
  </div>
193
197
  </section>
194
198
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
195
- <a name="force_authn" class="tsd-anchor"></a>
196
- <h3>force_<wbr>authn</h3>
197
- <div class="tsd-signature tsd-kind-icon">force_<wbr>authn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
199
+ <a name="forceAuthn" class="tsd-anchor"></a>
200
+ <h3>force<wbr>Authn</h3>
201
+ <div class="tsd-signature tsd-kind-icon">force<wbr>Authn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
198
202
  <aside class="tsd-sources">
199
203
  <ul>
200
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L679">types.ts:679</a></li>
204
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L608">datatypes.ts:608</a></li>
201
205
  </ul>
202
206
  </aside>
203
207
  <div class="tsd-comment tsd-typography">
@@ -207,12 +211,12 @@
207
211
  </div>
208
212
  </section>
209
213
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
210
- <a name="idp_metadata" class="tsd-anchor"></a>
211
- <h3>idp_<wbr>metadata</h3>
212
- <div class="tsd-signature tsd-kind-icon">idp_<wbr>metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
214
+ <a name="idpMetadata" class="tsd-anchor"></a>
215
+ <h3>idp<wbr>Metadata</h3>
216
+ <div class="tsd-signature tsd-kind-icon">idp<wbr>Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
213
217
  <aside class="tsd-sources">
214
218
  <ul>
215
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L677">types.ts:677</a></li>
219
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L606">datatypes.ts:606</a></li>
216
220
  </ul>
217
221
  </aside>
218
222
  <div class="tsd-comment tsd-typography">
@@ -222,12 +226,12 @@
222
226
  </div>
223
227
  </section>
224
228
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
225
- <a name="inactivity_timeout" class="tsd-anchor"></a>
226
- <h3>inactivity_<wbr>timeout</h3>
227
- <div class="tsd-signature tsd-kind-icon">inactivity_<wbr>timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
229
+ <a name="inactivityTimeout" class="tsd-anchor"></a>
230
+ <h3>inactivity<wbr>Timeout</h3>
231
+ <div class="tsd-signature tsd-kind-icon">inactivity<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
228
232
  <aside class="tsd-sources">
229
233
  <ul>
230
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L673">types.ts:673</a></li>
234
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L602">datatypes.ts:602</a></li>
231
235
  </ul>
232
236
  </aside>
233
237
  <div class="tsd-comment tsd-typography">
@@ -237,12 +241,12 @@
237
241
  </div>
238
242
  </section>
239
243
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
240
- <a name="maximum_duration" class="tsd-anchor"></a>
241
- <h3>maximum_<wbr>duration</h3>
242
- <div class="tsd-signature tsd-kind-icon">maximum_<wbr>duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
244
+ <a name="maximumDuration" class="tsd-anchor"></a>
245
+ <h3>maximum<wbr>Duration</h3>
246
+ <div class="tsd-signature tsd-kind-icon">maximum<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
243
247
  <aside class="tsd-sources">
244
248
  <ul>
245
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L675">types.ts:675</a></li>
249
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L604">datatypes.ts:604</a></li>
246
250
  </ul>
247
251
  </aside>
248
252
  <div class="tsd-comment tsd-typography">
@@ -252,12 +256,12 @@
252
256
  </div>
253
257
  </section>
254
258
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
255
- <a name="metadata_url" class="tsd-anchor"></a>
256
- <h3>metadata_<wbr>url</h3>
257
- <div class="tsd-signature tsd-kind-icon">metadata_<wbr>url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
259
+ <a name="metadataUrl" class="tsd-anchor"></a>
260
+ <h3>metadata<wbr>Url</h3>
261
+ <div class="tsd-signature tsd-kind-icon">metadata<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
258
262
  <aside class="tsd-sources">
259
263
  <ul>
260
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L693">types.ts:693</a></li>
264
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L622">datatypes.ts:622</a></li>
261
265
  </ul>
262
266
  </aside>
263
267
  <div class="tsd-comment tsd-typography">
@@ -267,12 +271,27 @@
267
271
  </div>
268
272
  </section>
269
273
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
270
- <a name="options_passthrough" class="tsd-anchor"></a>
271
- <h3>options_<wbr>passthrough</h3>
272
- <div class="tsd-signature tsd-kind-icon">options_<wbr>passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
274
+ <a name="nameidFormat" class="tsd-anchor"></a>
275
+ <h3>nameid<wbr>Format</h3>
276
+ <div class="tsd-signature tsd-kind-icon">nameid<wbr>Format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
273
277
  <aside class="tsd-sources">
274
278
  <ul>
275
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L669">types.ts:669</a></li>
279
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L624">datatypes.ts:624</a></li>
280
+ </ul>
281
+ </aside>
282
+ <div class="tsd-comment tsd-typography">
283
+ <div class="lead">
284
+ <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>
285
+ </div>
286
+ </div>
287
+ </section>
288
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
289
+ <a name="optionsPassthrough" class="tsd-anchor"></a>
290
+ <h3>options<wbr>Passthrough</h3>
291
+ <div class="tsd-signature tsd-kind-icon">options<wbr>Passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
292
+ <aside class="tsd-sources">
293
+ <ul>
294
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L598">datatypes.ts:598</a></li>
276
295
  </ul>
277
296
  </aside>
278
297
  <div class="tsd-comment tsd-typography">
@@ -282,12 +301,12 @@
282
301
  </div>
283
302
  </section>
284
303
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
285
- <a name="request_signing_certificate_pem" class="tsd-anchor"></a>
286
- <h3>request_<wbr>signing_<wbr>certificate_<wbr>pem</h3>
287
- <div class="tsd-signature tsd-kind-icon">request_<wbr>signing_<wbr>certificate_<wbr>pem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
304
+ <a name="requestSigningCertificatePem" class="tsd-anchor"></a>
305
+ <h3>request<wbr>Signing<wbr>Certificate<wbr>Pem</h3>
306
+ <div class="tsd-signature tsd-kind-icon">request<wbr>Signing<wbr>Certificate<wbr>Pem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
288
307
  <aside class="tsd-sources">
289
308
  <ul>
290
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L691">types.ts:691</a></li>
309
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L620">datatypes.ts:620</a></li>
291
310
  </ul>
292
311
  </aside>
293
312
  <div class="tsd-comment tsd-typography">
@@ -297,12 +316,12 @@
297
316
  </div>
298
317
  </section>
299
318
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
300
- <a name="single_logout_url" class="tsd-anchor"></a>
301
- <h3>single_<wbr>logout_<wbr>url</h3>
302
- <div class="tsd-signature tsd-kind-icon">single_<wbr>logout_<wbr>url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
319
+ <a name="singleLogoutUrl" class="tsd-anchor"></a>
320
+ <h3>single<wbr>Logout<wbr>Url</h3>
321
+ <div class="tsd-signature tsd-kind-icon">single<wbr>Logout<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
303
322
  <aside class="tsd-sources">
304
323
  <ul>
305
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L689">types.ts:689</a></li>
324
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L618">datatypes.ts:618</a></li>
306
325
  </ul>
307
326
  </aside>
308
327
  <div class="tsd-comment tsd-typography">
@@ -317,7 +336,16 @@
317
336
  <nav class="tsd-navigation primary">
318
337
  <ul>
319
338
  <li class=" ">
320
- <a href="../modules.html">Exports</a>
339
+ <a href="../modules.html">Modules</a>
340
+ </li>
341
+ <li class=" tsd-kind-module">
342
+ <a href="../modules/client.html">client</a>
343
+ </li>
344
+ <li class="current tsd-kind-module">
345
+ <a href="../modules/datatypes.html">datatypes</a>
346
+ </li>
347
+ <li class=" tsd-kind-module">
348
+ <a href="../modules/services.html">services</a>
321
349
  </li>
322
350
  </ul>
323
351
  </nav>
@@ -325,50 +353,53 @@
325
353
  <ul class="before-current">
326
354
  </ul>
327
355
  <ul class="current">
328
- <li class="current tsd-kind-interface">
329
- <a href="endpointsaml.html" class="tsd-kind-icon">EndpointSAML</a>
356
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
357
+ <a href="datatypes.EndpointSAML.html" class="tsd-kind-icon">EndpointSAML</a>
330
358
  <ul>
331
359
  <li class=" tsd-kind-property tsd-parent-kind-interface">
332
- <a href="endpointsaml.html#allow_idp_initiated" class="tsd-kind-icon">allow_<wbr>idp_<wbr>initiated</a>
360
+ <a href="datatypes.EndpointSAML.html#allowIdpInitiated" class="tsd-kind-icon">allow<wbr>Idp<wbr>Initiated</a>
333
361
  </li>
334
362
  <li class=" tsd-kind-property tsd-parent-kind-interface">
335
- <a href="endpointsaml.html#assertion_consumer_service_url" class="tsd-kind-icon">assertion_<wbr>consumer_<wbr>service_<wbr>url</a>
363
+ <a href="datatypes.EndpointSAML.html#assertionConsumerServiceUrl" class="tsd-kind-icon">assertion<wbr>Consumer<wbr>Service<wbr>Url</a>
336
364
  </li>
337
365
  <li class=" tsd-kind-property tsd-parent-kind-interface">
338
- <a href="endpointsaml.html#authorized_groups" class="tsd-kind-icon">authorized_<wbr>groups</a>
366
+ <a href="datatypes.EndpointSAML.html#authorizedGroups" class="tsd-kind-icon">authorized<wbr>Groups</a>
339
367
  </li>
340
368
  <li class=" tsd-kind-property tsd-parent-kind-interface">
341
- <a href="endpointsaml.html#cookie_prefix" class="tsd-kind-icon">cookie_<wbr>prefix</a>
369
+ <a href="datatypes.EndpointSAML.html#cookiePrefix" class="tsd-kind-icon">cookie<wbr>Prefix</a>
342
370
  </li>
343
371
  <li class=" tsd-kind-property tsd-parent-kind-interface">
344
- <a href="endpointsaml.html#enabled" class="tsd-kind-icon">enabled</a>
372
+ <a href="datatypes.EndpointSAML.html#enabled" class="tsd-kind-icon">enabled</a>
345
373
  </li>
346
374
  <li class=" tsd-kind-property tsd-parent-kind-interface">
347
- <a href="endpointsaml.html#entity_id" class="tsd-kind-icon">entity_<wbr>id</a>
375
+ <a href="datatypes.EndpointSAML.html#entityId" class="tsd-kind-icon">entity<wbr>Id</a>
348
376
  </li>
349
377
  <li class=" tsd-kind-property tsd-parent-kind-interface">
350
- <a href="endpointsaml.html#force_authn" class="tsd-kind-icon">force_<wbr>authn</a>
378
+ <a href="datatypes.EndpointSAML.html#forceAuthn" class="tsd-kind-icon">force<wbr>Authn</a>
351
379
  </li>
352
380
  <li class=" tsd-kind-property tsd-parent-kind-interface">
353
- <a href="endpointsaml.html#idp_metadata" class="tsd-kind-icon">idp_<wbr>metadata</a>
381
+ <a href="datatypes.EndpointSAML.html#idpMetadata" class="tsd-kind-icon">idp<wbr>Metadata</a>
354
382
  </li>
355
383
  <li class=" tsd-kind-property tsd-parent-kind-interface">
356
- <a href="endpointsaml.html#inactivity_timeout" class="tsd-kind-icon">inactivity_<wbr>timeout</a>
384
+ <a href="datatypes.EndpointSAML.html#inactivityTimeout" class="tsd-kind-icon">inactivity<wbr>Timeout</a>
357
385
  </li>
358
386
  <li class=" tsd-kind-property tsd-parent-kind-interface">
359
- <a href="endpointsaml.html#maximum_duration" class="tsd-kind-icon">maximum_<wbr>duration</a>
387
+ <a href="datatypes.EndpointSAML.html#maximumDuration" class="tsd-kind-icon">maximum<wbr>Duration</a>
360
388
  </li>
361
389
  <li class=" tsd-kind-property tsd-parent-kind-interface">
362
- <a href="endpointsaml.html#metadata_url" class="tsd-kind-icon">metadata_<wbr>url</a>
390
+ <a href="datatypes.EndpointSAML.html#metadataUrl" class="tsd-kind-icon">metadata<wbr>Url</a>
363
391
  </li>
364
392
  <li class=" tsd-kind-property tsd-parent-kind-interface">
365
- <a href="endpointsaml.html#options_passthrough" class="tsd-kind-icon">options_<wbr>passthrough</a>
393
+ <a href="datatypes.EndpointSAML.html#nameidFormat" class="tsd-kind-icon">nameid<wbr>Format</a>
366
394
  </li>
367
395
  <li class=" tsd-kind-property tsd-parent-kind-interface">
368
- <a href="endpointsaml.html#request_signing_certificate_pem" class="tsd-kind-icon">request_<wbr>signing_<wbr>certificate_<wbr>pem</a>
396
+ <a href="datatypes.EndpointSAML.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a>
369
397
  </li>
370
398
  <li class=" tsd-kind-property tsd-parent-kind-interface">
371
- <a href="endpointsaml.html#single_logout_url" class="tsd-kind-icon">single_<wbr>logout_<wbr>url</a>
399
+ <a href="datatypes.EndpointSAML.html#requestSigningCertificatePem" class="tsd-kind-icon">request<wbr>Signing<wbr>Certificate<wbr>Pem</a>
400
+ </li>
401
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
402
+ <a href="datatypes.EndpointSAML.html#singleLogoutUrl" class="tsd-kind-icon">single<wbr>Logout<wbr>Url</a>
372
403
  </li>
373
404
  </ul>
374
405
  </li>
@@ -384,11 +415,11 @@
384
415
  <h2>Legend</h2>
385
416
  <div class="tsd-legend-group">
386
417
  <ul class="tsd-legend">
387
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
388
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
418
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
419
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
389
420
  </ul>
390
421
  <ul class="tsd-legend">
391
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
422
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
392
423
  </ul>
393
424
  </div>
394
425
  </div>