@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/{endpointoauthprovider.html → datatypes.EndpointOAuthProvider.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="endpointoauthprovider.html">EndpointOAuthProvider</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointOAuthProvider.html">EndpointOAuthProvider</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointOAuthProvider</h1>
@@ -80,10 +83,10 @@
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="endpointoauthprovider.html#facebook" class="tsd-kind-icon">facebook</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoauthprovider.html#github" class="tsd-kind-icon">github</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoauthprovider.html#google" class="tsd-kind-icon">google</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoauthprovider.html#microsoft" class="tsd-kind-icon">microsoft</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthProvider.html#facebook" class="tsd-kind-icon">facebook</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthProvider.html#github" class="tsd-kind-icon">github</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthProvider.html#google" class="tsd-kind-icon">google</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthProvider.html#microsoft" class="tsd-kind-icon">microsoft</a></li>
87
90
  </ul>
88
91
  </section>
89
92
  </div>
@@ -94,10 +97,10 @@
94
97
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
95
98
  <a name="facebook" class="tsd-anchor"></a>
96
99
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> facebook</h3>
97
- <div class="tsd-signature tsd-kind-icon">facebook<span class="tsd-signature-symbol">:</span> <a href="endpointoauthfacebook.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthFacebook</a></div>
100
+ <div class="tsd-signature tsd-kind-icon">facebook<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthFacebook.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthFacebook</a></div>
98
101
  <aside class="tsd-sources">
99
102
  <ul>
100
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L602">types.ts:602</a></li>
103
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L531">datatypes.ts:531</a></li>
101
104
  </ul>
102
105
  </aside>
103
106
  <div class="tsd-comment tsd-typography">
@@ -109,10 +112,10 @@
109
112
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
110
113
  <a name="github" class="tsd-anchor"></a>
111
114
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> github</h3>
112
- <div class="tsd-signature tsd-kind-icon">github<span class="tsd-signature-symbol">:</span> <a href="endpointoauthgithub.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthGitHub</a></div>
115
+ <div class="tsd-signature tsd-kind-icon">github<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthGitHub.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthGitHub</a></div>
113
116
  <aside class="tsd-sources">
114
117
  <ul>
115
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L600">types.ts:600</a></li>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L529">datatypes.ts:529</a></li>
116
119
  </ul>
117
120
  </aside>
118
121
  <div class="tsd-comment tsd-typography">
@@ -124,10 +127,10 @@
124
127
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
125
128
  <a name="google" class="tsd-anchor"></a>
126
129
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> google</h3>
127
- <div class="tsd-signature tsd-kind-icon">google<span class="tsd-signature-symbol">:</span> <a href="endpointoauthgoogle.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthGoogle</a></div>
130
+ <div class="tsd-signature tsd-kind-icon">google<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthGoogle.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthGoogle</a></div>
128
131
  <aside class="tsd-sources">
129
132
  <ul>
130
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L606">types.ts:606</a></li>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L535">datatypes.ts:535</a></li>
131
134
  </ul>
132
135
  </aside>
133
136
  <div class="tsd-comment tsd-typography">
@@ -139,10 +142,10 @@
139
142
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
140
143
  <a name="microsoft" class="tsd-anchor"></a>
141
144
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> microsoft</h3>
142
- <div class="tsd-signature tsd-kind-icon">microsoft<span class="tsd-signature-symbol">:</span> <a href="endpointoauthmicrosoft.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthMicrosoft</a></div>
145
+ <div class="tsd-signature tsd-kind-icon">microsoft<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthMicrosoft.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthMicrosoft</a></div>
143
146
  <aside class="tsd-sources">
144
147
  <ul>
145
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L604">types.ts:604</a></li>
148
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L533">datatypes.ts:533</a></li>
146
149
  </ul>
147
150
  </aside>
148
151
  <div class="tsd-comment tsd-typography">
@@ -157,7 +160,16 @@
157
160
  <nav class="tsd-navigation primary">
158
161
  <ul>
159
162
  <li class=" ">
160
- <a href="../modules.html">Exports</a>
163
+ <a href="../modules.html">Modules</a>
164
+ </li>
165
+ <li class=" tsd-kind-module">
166
+ <a href="../modules/client.html">client</a>
167
+ </li>
168
+ <li class="current tsd-kind-module">
169
+ <a href="../modules/datatypes.html">datatypes</a>
170
+ </li>
171
+ <li class=" tsd-kind-module">
172
+ <a href="../modules/services.html">services</a>
161
173
  </li>
162
174
  </ul>
163
175
  </nav>
@@ -165,20 +177,20 @@
165
177
  <ul class="before-current">
166
178
  </ul>
167
179
  <ul class="current">
168
- <li class="current tsd-kind-interface">
169
- <a href="endpointoauthprovider.html" class="tsd-kind-icon">EndpointOAuth<wbr>Provider</a>
180
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
181
+ <a href="datatypes.EndpointOAuthProvider.html" class="tsd-kind-icon">EndpointOAuth<wbr>Provider</a>
170
182
  <ul>
171
183
  <li class=" tsd-kind-property tsd-parent-kind-interface">
172
- <a href="endpointoauthprovider.html#facebook" class="tsd-kind-icon">facebook</a>
184
+ <a href="datatypes.EndpointOAuthProvider.html#facebook" class="tsd-kind-icon">facebook</a>
173
185
  </li>
174
186
  <li class=" tsd-kind-property tsd-parent-kind-interface">
175
- <a href="endpointoauthprovider.html#github" class="tsd-kind-icon">github</a>
187
+ <a href="datatypes.EndpointOAuthProvider.html#github" class="tsd-kind-icon">github</a>
176
188
  </li>
177
189
  <li class=" tsd-kind-property tsd-parent-kind-interface">
178
- <a href="endpointoauthprovider.html#google" class="tsd-kind-icon">google</a>
190
+ <a href="datatypes.EndpointOAuthProvider.html#google" class="tsd-kind-icon">google</a>
179
191
  </li>
180
192
  <li class=" tsd-kind-property tsd-parent-kind-interface">
181
- <a href="endpointoauthprovider.html#microsoft" class="tsd-kind-icon">microsoft</a>
193
+ <a href="datatypes.EndpointOAuthProvider.html#microsoft" class="tsd-kind-icon">microsoft</a>
182
194
  </li>
183
195
  </ul>
184
196
  </li>
@@ -194,11 +206,11 @@
194
206
  <h2>Legend</h2>
195
207
  <div class="tsd-legend-group">
196
208
  <ul class="tsd-legend">
197
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
198
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
209
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
210
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
199
211
  </ul>
200
212
  <ul class="tsd-legend">
201
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
213
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
202
214
  </ul>
203
215
  </div>
204
216
  </div>
package/docs/interfaces/{endpointoidc.html → datatypes.EndpointOIDC.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="endpointoidc.html">EndpointOIDC</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointOIDC.html">EndpointOIDC</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointOIDC</h1>
@@ -80,15 +83,15 @@
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="endpointoidc.html#client_id" class="tsd-kind-icon">client_<wbr>id</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoidc.html#client_secret" class="tsd-kind-icon">client_<wbr>secret</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoidc.html#cookie_prefix" class="tsd-kind-icon">cookie_<wbr>prefix</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoidc.html#enabled" class="tsd-kind-icon">enabled</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoidc.html#inactivity_timeout" class="tsd-kind-icon">inactivity_<wbr>timeout</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoidc.html#issuer" class="tsd-kind-icon">issuer</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoidc.html#maximum_duration" class="tsd-kind-icon">maximum_<wbr>duration</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoidc.html#options_passthrough" class="tsd-kind-icon">options_<wbr>passthrough</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoidc.html#scopes" class="tsd-kind-icon">scopes</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#clientId" class="tsd-kind-icon">client<wbr>Id</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#clientSecret" class="tsd-kind-icon">client<wbr>Secret</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#cookiePrefix" class="tsd-kind-icon">cookie<wbr>Prefix</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#enabled" class="tsd-kind-icon">enabled</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#inactivityTimeout" class="tsd-kind-icon">inactivity<wbr>Timeout</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#issuer" class="tsd-kind-icon">issuer</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#maximumDuration" class="tsd-kind-icon">maximum<wbr>Duration</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#scopes" class="tsd-kind-icon">scopes</a></li>
92
95
  </ul>
93
96
  </section>
94
97
  </div>
@@ -97,12 +100,12 @@
97
100
  <section class="tsd-panel-group tsd-member-group ">
98
101
  <h2>Properties</h2>
99
102
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
100
- <a name="client_id" class="tsd-anchor"></a>
101
- <h3>client_<wbr>id</h3>
102
- <div class="tsd-signature tsd-kind-icon">client_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
103
+ <a name="clientId" class="tsd-anchor"></a>
104
+ <h3>client<wbr>Id</h3>
105
+ <div class="tsd-signature tsd-kind-icon">client<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
103
106
  <aside class="tsd-sources">
104
107
  <ul>
105
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L731">types.ts:731</a></li>
108
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L664">datatypes.ts:664</a></li>
106
109
  </ul>
107
110
  </aside>
108
111
  <div class="tsd-comment tsd-typography">
@@ -112,12 +115,12 @@
112
115
  </div>
113
116
  </section>
114
117
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
115
- <a name="client_secret" class="tsd-anchor"></a>
116
- <h3>client_<wbr>secret</h3>
117
- <div class="tsd-signature tsd-kind-icon">client_<wbr>secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
118
+ <a name="clientSecret" class="tsd-anchor"></a>
119
+ <h3>client<wbr>Secret</h3>
120
+ <div class="tsd-signature tsd-kind-icon">client<wbr>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
118
121
  <aside class="tsd-sources">
119
122
  <ul>
120
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L733">types.ts:733</a></li>
123
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L666">datatypes.ts:666</a></li>
121
124
  </ul>
122
125
  </aside>
123
126
  <div class="tsd-comment tsd-typography">
@@ -127,12 +130,12 @@
127
130
  </div>
128
131
  </section>
129
132
  <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>
133
+ <a name="cookiePrefix" class="tsd-anchor"></a>
134
+ <h3>cookie<wbr>Prefix</h3>
135
+ <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
136
  <aside class="tsd-sources">
134
137
  <ul>
135
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L723">types.ts:723</a></li>
138
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L656">datatypes.ts:656</a></li>
136
139
  </ul>
137
140
  </aside>
138
141
  <div class="tsd-comment tsd-typography">
@@ -147,22 +150,22 @@
147
150
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
148
151
  <aside class="tsd-sources">
149
152
  <ul>
150
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L719">types.ts:719</a></li>
153
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L652">datatypes.ts:652</a></li>
151
154
  </ul>
152
155
  </aside>
153
156
  <div class="tsd-comment tsd-typography">
154
157
  <div class="lead">
155
- <p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
158
+ <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
159
  </div>
157
160
  </div>
158
161
  </section>
159
162
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
160
- <a name="inactivity_timeout" class="tsd-anchor"></a>
161
- <h3>inactivity_<wbr>timeout</h3>
162
- <div class="tsd-signature tsd-kind-icon">inactivity_<wbr>timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
163
+ <a name="inactivityTimeout" class="tsd-anchor"></a>
164
+ <h3>inactivity<wbr>Timeout</h3>
165
+ <div class="tsd-signature tsd-kind-icon">inactivity<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
163
166
  <aside class="tsd-sources">
164
167
  <ul>
165
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L725">types.ts:725</a></li>
168
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L658">datatypes.ts:658</a></li>
166
169
  </ul>
167
170
  </aside>
168
171
  <div class="tsd-comment tsd-typography">
@@ -177,7 +180,7 @@
177
180
  <div class="tsd-signature tsd-kind-icon">issuer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
178
181
  <aside class="tsd-sources">
179
182
  <ul>
180
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L729">types.ts:729</a></li>
183
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L662">datatypes.ts:662</a></li>
181
184
  </ul>
182
185
  </aside>
183
186
  <div class="tsd-comment tsd-typography">
@@ -187,12 +190,12 @@
187
190
  </div>
188
191
  </section>
189
192
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
190
- <a name="maximum_duration" class="tsd-anchor"></a>
191
- <h3>maximum_<wbr>duration</h3>
192
- <div class="tsd-signature tsd-kind-icon">maximum_<wbr>duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
193
+ <a name="maximumDuration" class="tsd-anchor"></a>
194
+ <h3>maximum<wbr>Duration</h3>
195
+ <div class="tsd-signature tsd-kind-icon">maximum<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
193
196
  <aside class="tsd-sources">
194
197
  <ul>
195
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L727">types.ts:727</a></li>
198
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L660">datatypes.ts:660</a></li>
196
199
  </ul>
197
200
  </aside>
198
201
  <div class="tsd-comment tsd-typography">
@@ -202,12 +205,12 @@
202
205
  </div>
203
206
  </section>
204
207
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
205
- <a name="options_passthrough" class="tsd-anchor"></a>
206
- <h3>options_<wbr>passthrough</h3>
207
- <div class="tsd-signature tsd-kind-icon">options_<wbr>passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
208
+ <a name="optionsPassthrough" class="tsd-anchor"></a>
209
+ <h3>options<wbr>Passthrough</h3>
210
+ <div class="tsd-signature tsd-kind-icon">options<wbr>Passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
208
211
  <aside class="tsd-sources">
209
212
  <ul>
210
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L721">types.ts:721</a></li>
213
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L654">datatypes.ts:654</a></li>
211
214
  </ul>
212
215
  </aside>
213
216
  <div class="tsd-comment tsd-typography">
@@ -222,7 +225,7 @@
222
225
  <div class="tsd-signature tsd-kind-icon">scopes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
223
226
  <aside class="tsd-sources">
224
227
  <ul>
225
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L735">types.ts:735</a></li>
228
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L668">datatypes.ts:668</a></li>
226
229
  </ul>
227
230
  </aside>
228
231
  <div class="tsd-comment tsd-typography">
@@ -237,7 +240,16 @@
237
240
  <nav class="tsd-navigation primary">
238
241
  <ul>
239
242
  <li class=" ">
240
- <a href="../modules.html">Exports</a>
243
+ <a href="../modules.html">Modules</a>
244
+ </li>
245
+ <li class=" tsd-kind-module">
246
+ <a href="../modules/client.html">client</a>
247
+ </li>
248
+ <li class="current tsd-kind-module">
249
+ <a href="../modules/datatypes.html">datatypes</a>
250
+ </li>
251
+ <li class=" tsd-kind-module">
252
+ <a href="../modules/services.html">services</a>
241
253
  </li>
242
254
  </ul>
243
255
  </nav>
@@ -245,35 +257,35 @@
245
257
  <ul class="before-current">
246
258
  </ul>
247
259
  <ul class="current">
248
- <li class="current tsd-kind-interface">
249
- <a href="endpointoidc.html" class="tsd-kind-icon">EndpointOIDC</a>
260
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
261
+ <a href="datatypes.EndpointOIDC.html" class="tsd-kind-icon">EndpointOIDC</a>
250
262
  <ul>
251
263
  <li class=" tsd-kind-property tsd-parent-kind-interface">
252
- <a href="endpointoidc.html#client_id" class="tsd-kind-icon">client_<wbr>id</a>
264
+ <a href="datatypes.EndpointOIDC.html#clientId" class="tsd-kind-icon">client<wbr>Id</a>
253
265
  </li>
254
266
  <li class=" tsd-kind-property tsd-parent-kind-interface">
255
- <a href="endpointoidc.html#client_secret" class="tsd-kind-icon">client_<wbr>secret</a>
267
+ <a href="datatypes.EndpointOIDC.html#clientSecret" class="tsd-kind-icon">client<wbr>Secret</a>
256
268
  </li>
257
269
  <li class=" tsd-kind-property tsd-parent-kind-interface">
258
- <a href="endpointoidc.html#cookie_prefix" class="tsd-kind-icon">cookie_<wbr>prefix</a>
270
+ <a href="datatypes.EndpointOIDC.html#cookiePrefix" class="tsd-kind-icon">cookie<wbr>Prefix</a>
259
271
  </li>
260
272
  <li class=" tsd-kind-property tsd-parent-kind-interface">
261
- <a href="endpointoidc.html#enabled" class="tsd-kind-icon">enabled</a>
273
+ <a href="datatypes.EndpointOIDC.html#enabled" class="tsd-kind-icon">enabled</a>
262
274
  </li>
263
275
  <li class=" tsd-kind-property tsd-parent-kind-interface">
264
- <a href="endpointoidc.html#inactivity_timeout" class="tsd-kind-icon">inactivity_<wbr>timeout</a>
276
+ <a href="datatypes.EndpointOIDC.html#inactivityTimeout" class="tsd-kind-icon">inactivity<wbr>Timeout</a>
265
277
  </li>
266
278
  <li class=" tsd-kind-property tsd-parent-kind-interface">
267
- <a href="endpointoidc.html#issuer" class="tsd-kind-icon">issuer</a>
279
+ <a href="datatypes.EndpointOIDC.html#issuer" class="tsd-kind-icon">issuer</a>
268
280
  </li>
269
281
  <li class=" tsd-kind-property tsd-parent-kind-interface">
270
- <a href="endpointoidc.html#maximum_duration" class="tsd-kind-icon">maximum_<wbr>duration</a>
282
+ <a href="datatypes.EndpointOIDC.html#maximumDuration" class="tsd-kind-icon">maximum<wbr>Duration</a>
271
283
  </li>
272
284
  <li class=" tsd-kind-property tsd-parent-kind-interface">
273
- <a href="endpointoidc.html#options_passthrough" class="tsd-kind-icon">options_<wbr>passthrough</a>
285
+ <a href="datatypes.EndpointOIDC.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a>
274
286
  </li>
275
287
  <li class=" tsd-kind-property tsd-parent-kind-interface">
276
- <a href="endpointoidc.html#scopes" class="tsd-kind-icon">scopes</a>
288
+ <a href="datatypes.EndpointOIDC.html#scopes" class="tsd-kind-icon">scopes</a>
277
289
  </li>
278
290
  </ul>
279
291
  </li>
@@ -289,11 +301,11 @@
289
301
  <h2>Legend</h2>
290
302
  <div class="tsd-legend-group">
291
303
  <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>
304
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
305
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
294
306
  </ul>
295
307
  <ul class="tsd-legend">
296
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
308
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
297
309
  </ul>
298
310
  </div>
299
311
  </div>
package/docs/interfaces/{endpointrequestheaders.html → datatypes.EndpointRequestHeaders.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="endpointrequestheaders.html">EndpointRequestHeaders</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointRequestHeaders.html">EndpointRequestHeaders</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointRequestHeaders</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="endpointrequestheaders.html#add" class="tsd-kind-icon">add</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointrequestheaders.html#enabled" class="tsd-kind-icon">enabled</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointrequestheaders.html#remove" class="tsd-kind-icon">remove</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointRequestHeaders.html#add" class="tsd-kind-icon">add</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointRequestHeaders.html#enabled" class="tsd-kind-icon">enabled</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointRequestHeaders.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#L539">types.ts:539</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L468">datatypes.ts:468</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#L537">types.ts:537</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L466">datatypes.ts:466</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#L541">types.ts:541</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L470">datatypes.ts:470</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="endpointrequestheaders.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers</a>
164
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
165
+ <a href="datatypes.EndpointRequestHeaders.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers</a>
154
166
  <ul>
155
167
  <li class=" tsd-kind-property tsd-parent-kind-interface">
156
- <a href="endpointrequestheaders.html#add" class="tsd-kind-icon">add</a>
168
+ <a href="datatypes.EndpointRequestHeaders.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="endpointrequestheaders.html#enabled" class="tsd-kind-icon">enabled</a>
171
+ <a href="datatypes.EndpointRequestHeaders.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="endpointrequestheaders.html#remove" class="tsd-kind-icon">remove</a>
174
+ <a href="datatypes.EndpointRequestHeaders.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>