@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/{tunnelsession.html → datatypes.TunnelSession.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="tunnelsession.html">TunnelSession</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.TunnelSession.html">TunnelSession</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface TunnelSession</h1>
@@ -80,16 +83,16 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tunnelsession.html#agent_version" class="tsd-kind-icon">agent_<wbr>version</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tunnelsession.html#credential" class="tsd-kind-icon">credential</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tunnelsession.html#id" class="tsd-kind-icon">id</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tunnelsession.html#ip" class="tsd-kind-icon">ip</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tunnelsession.html#metadata" class="tsd-kind-icon">metadata</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tunnelsession.html#os" class="tsd-kind-icon">os</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tunnelsession.html#region" class="tsd-kind-icon">region</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tunnelsession.html#started_at" class="tsd-kind-icon">started_<wbr>at</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tunnelsession.html#transport" class="tsd-kind-icon">transport</a></li>
92
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tunnelsession.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelSession.html#agentVersion" class="tsd-kind-icon">agent<wbr>Version</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelSession.html#credential" class="tsd-kind-icon">credential</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelSession.html#id" class="tsd-kind-icon">id</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelSession.html#ip" class="tsd-kind-icon">ip</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelSession.html#metadata" class="tsd-kind-icon">metadata</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelSession.html#os" class="tsd-kind-icon">os</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelSession.html#region" class="tsd-kind-icon">region</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelSession.html#startedAt" class="tsd-kind-icon">started<wbr>At</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelSession.html#transport" class="tsd-kind-icon">transport</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelSession.html#uri" class="tsd-kind-icon">uri</a></li>
93
96
  </ul>
94
97
  </section>
95
98
  </div>
@@ -98,12 +101,12 @@
98
101
  <section class="tsd-panel-group tsd-member-group ">
99
102
  <h2>Properties</h2>
100
103
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
101
- <a name="agent_version" class="tsd-anchor"></a>
102
- <h3>agent_<wbr>version</h3>
103
- <div class="tsd-signature tsd-kind-icon">agent_<wbr>version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
104
+ <a name="agentVersion" class="tsd-anchor"></a>
105
+ <h3>agent<wbr>Version</h3>
106
+ <div class="tsd-signature tsd-kind-icon">agent<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
104
107
  <aside class="tsd-sources">
105
108
  <ul>
106
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1817">types.ts:1817</a></li>
109
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1880">datatypes.ts:1880</a></li>
107
110
  </ul>
108
111
  </aside>
109
112
  <div class="tsd-comment tsd-typography">
@@ -115,10 +118,10 @@
115
118
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
116
119
  <a name="credential" class="tsd-anchor"></a>
117
120
  <h3>credential</h3>
118
- <div class="tsd-signature tsd-kind-icon">credential<span class="tsd-signature-symbol">:</span> <a href="ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
121
+ <div class="tsd-signature tsd-kind-icon">credential<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
119
122
  <aside class="tsd-sources">
120
123
  <ul>
121
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1819">types.ts:1819</a></li>
124
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1882">datatypes.ts:1882</a></li>
122
125
  </ul>
123
126
  </aside>
124
127
  <div class="tsd-comment tsd-typography">
@@ -133,7 +136,7 @@
133
136
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
134
137
  <aside class="tsd-sources">
135
138
  <ul>
136
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1821">types.ts:1821</a></li>
139
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1884">datatypes.ts:1884</a></li>
137
140
  </ul>
138
141
  </aside>
139
142
  <div class="tsd-comment tsd-typography">
@@ -148,7 +151,7 @@
148
151
  <div class="tsd-signature tsd-kind-icon">ip<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
149
152
  <aside class="tsd-sources">
150
153
  <ul>
151
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1823">types.ts:1823</a></li>
154
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1886">datatypes.ts:1886</a></li>
152
155
  </ul>
153
156
  </aside>
154
157
  <div class="tsd-comment tsd-typography">
@@ -163,7 +166,7 @@
163
166
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
164
167
  <aside class="tsd-sources">
165
168
  <ul>
166
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1825">types.ts:1825</a></li>
169
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1888">datatypes.ts:1888</a></li>
167
170
  </ul>
168
171
  </aside>
169
172
  <div class="tsd-comment tsd-typography">
@@ -178,7 +181,7 @@
178
181
  <div class="tsd-signature tsd-kind-icon">os<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
179
182
  <aside class="tsd-sources">
180
183
  <ul>
181
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1827">types.ts:1827</a></li>
184
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1890">datatypes.ts:1890</a></li>
182
185
  </ul>
183
186
  </aside>
184
187
  <div class="tsd-comment tsd-typography">
@@ -193,7 +196,7 @@
193
196
  <div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
194
197
  <aside class="tsd-sources">
195
198
  <ul>
196
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1829">types.ts:1829</a></li>
199
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1892">datatypes.ts:1892</a></li>
197
200
  </ul>
198
201
  </aside>
199
202
  <div class="tsd-comment tsd-typography">
@@ -203,12 +206,12 @@
203
206
  </div>
204
207
  </section>
205
208
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
206
- <a name="started_at" class="tsd-anchor"></a>
207
- <h3>started_<wbr>at</h3>
208
- <div class="tsd-signature tsd-kind-icon">started_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
209
+ <a name="startedAt" class="tsd-anchor"></a>
210
+ <h3>started<wbr>At</h3>
211
+ <div class="tsd-signature tsd-kind-icon">started<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
209
212
  <aside class="tsd-sources">
210
213
  <ul>
211
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1831">types.ts:1831</a></li>
214
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1894">datatypes.ts:1894</a></li>
212
215
  </ul>
213
216
  </aside>
214
217
  <div class="tsd-comment tsd-typography">
@@ -223,12 +226,12 @@
223
226
  <div class="tsd-signature tsd-kind-icon">transport<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
224
227
  <aside class="tsd-sources">
225
228
  <ul>
226
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1833">types.ts:1833</a></li>
229
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1896">datatypes.ts:1896</a></li>
227
230
  </ul>
228
231
  </aside>
229
232
  <div class="tsd-comment tsd-typography">
230
233
  <div class="lead">
231
- <p>the transport protocol used to start the tunnel session. Either ngrok/v2 or ssh</p>
234
+ <p>the transport protocol used to start the tunnel session. Either <code>ngrok/v2</code> or <code>ssh</code></p>
232
235
  </div>
233
236
  </div>
234
237
  </section>
@@ -238,7 +241,7 @@
238
241
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
239
242
  <aside class="tsd-sources">
240
243
  <ul>
241
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1835">types.ts:1835</a></li>
244
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1898">datatypes.ts:1898</a></li>
242
245
  </ul>
243
246
  </aside>
244
247
  <div class="tsd-comment tsd-typography">
@@ -253,7 +256,16 @@
253
256
  <nav class="tsd-navigation primary">
254
257
  <ul>
255
258
  <li class=" ">
256
- <a href="../modules.html">Exports</a>
259
+ <a href="../modules.html">Modules</a>
260
+ </li>
261
+ <li class=" tsd-kind-module">
262
+ <a href="../modules/client.html">client</a>
263
+ </li>
264
+ <li class="current tsd-kind-module">
265
+ <a href="../modules/datatypes.html">datatypes</a>
266
+ </li>
267
+ <li class=" tsd-kind-module">
268
+ <a href="../modules/services.html">services</a>
257
269
  </li>
258
270
  </ul>
259
271
  </nav>
@@ -261,38 +273,38 @@
261
273
  <ul class="before-current">
262
274
  </ul>
263
275
  <ul class="current">
264
- <li class="current tsd-kind-interface">
265
- <a href="tunnelsession.html" class="tsd-kind-icon">Tunnel<wbr>Session</a>
276
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
277
+ <a href="datatypes.TunnelSession.html" class="tsd-kind-icon">Tunnel<wbr>Session</a>
266
278
  <ul>
267
279
  <li class=" tsd-kind-property tsd-parent-kind-interface">
268
- <a href="tunnelsession.html#agent_version" class="tsd-kind-icon">agent_<wbr>version</a>
280
+ <a href="datatypes.TunnelSession.html#agentVersion" class="tsd-kind-icon">agent<wbr>Version</a>
269
281
  </li>
270
282
  <li class=" tsd-kind-property tsd-parent-kind-interface">
271
- <a href="tunnelsession.html#credential" class="tsd-kind-icon">credential</a>
283
+ <a href="datatypes.TunnelSession.html#credential" class="tsd-kind-icon">credential</a>
272
284
  </li>
273
285
  <li class=" tsd-kind-property tsd-parent-kind-interface">
274
- <a href="tunnelsession.html#id" class="tsd-kind-icon">id</a>
286
+ <a href="datatypes.TunnelSession.html#id" class="tsd-kind-icon">id</a>
275
287
  </li>
276
288
  <li class=" tsd-kind-property tsd-parent-kind-interface">
277
- <a href="tunnelsession.html#ip" class="tsd-kind-icon">ip</a>
289
+ <a href="datatypes.TunnelSession.html#ip" class="tsd-kind-icon">ip</a>
278
290
  </li>
279
291
  <li class=" tsd-kind-property tsd-parent-kind-interface">
280
- <a href="tunnelsession.html#metadata" class="tsd-kind-icon">metadata</a>
292
+ <a href="datatypes.TunnelSession.html#metadata" class="tsd-kind-icon">metadata</a>
281
293
  </li>
282
294
  <li class=" tsd-kind-property tsd-parent-kind-interface">
283
- <a href="tunnelsession.html#os" class="tsd-kind-icon">os</a>
295
+ <a href="datatypes.TunnelSession.html#os" class="tsd-kind-icon">os</a>
284
296
  </li>
285
297
  <li class=" tsd-kind-property tsd-parent-kind-interface">
286
- <a href="tunnelsession.html#region" class="tsd-kind-icon">region</a>
298
+ <a href="datatypes.TunnelSession.html#region" class="tsd-kind-icon">region</a>
287
299
  </li>
288
300
  <li class=" tsd-kind-property tsd-parent-kind-interface">
289
- <a href="tunnelsession.html#started_at" class="tsd-kind-icon">started_<wbr>at</a>
301
+ <a href="datatypes.TunnelSession.html#startedAt" class="tsd-kind-icon">started<wbr>At</a>
290
302
  </li>
291
303
  <li class=" tsd-kind-property tsd-parent-kind-interface">
292
- <a href="tunnelsession.html#transport" class="tsd-kind-icon">transport</a>
304
+ <a href="datatypes.TunnelSession.html#transport" class="tsd-kind-icon">transport</a>
293
305
  </li>
294
306
  <li class=" tsd-kind-property tsd-parent-kind-interface">
295
- <a href="tunnelsession.html#uri" class="tsd-kind-icon">uri</a>
307
+ <a href="datatypes.TunnelSession.html#uri" class="tsd-kind-icon">uri</a>
296
308
  </li>
297
309
  </ul>
298
310
  </li>
@@ -308,11 +320,11 @@
308
320
  <h2>Legend</h2>
309
321
  <div class="tsd-legend-group">
310
322
  <ul class="tsd-legend">
311
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
312
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
323
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
324
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
313
325
  </ul>
314
326
  <ul class="tsd-legend">
315
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
327
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
316
328
  </ul>
317
329
  </div>
318
330
  </div>
package/docs/interfaces/{tunnelsessionlist.html → datatypes.TunnelSessionList.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="tunnelsessionlist.html">TunnelSessionList</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.TunnelSessionList.html">TunnelSessionList</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface TunnelSessionList</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="tunnelsessionlist.html#next_page_uri" class="tsd-kind-icon">next_<wbr>page_<wbr>uri</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tunnelsessionlist.html#tunnel_sessions" class="tsd-kind-icon">tunnel_<wbr>sessions</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tunnelsessionlist.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelSessionList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelSessionList.html#tunnelSessions" class="tsd-kind-icon">tunnel<wbr>Sessions</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelSessionList.html#uri" class="tsd-kind-icon">uri</a></li>
86
89
  </ul>
87
90
  </section>
88
91
  </div>
@@ -91,12 +94,12 @@
91
94
  <section class="tsd-panel-group tsd-member-group ">
92
95
  <h2>Properties</h2>
93
96
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
94
- <a name="next_page_uri" class="tsd-anchor"></a>
95
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> next_<wbr>page_<wbr>uri</h3>
96
- <div class="tsd-signature tsd-kind-icon">next_<wbr>page_<wbr>uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
97
+ <a name="nextPageUri" class="tsd-anchor"></a>
98
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> next<wbr>Page<wbr>Uri</h3>
99
+ <div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
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#L1844">types.ts:1844</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1907">datatypes.ts:1907</a></li>
100
103
  </ul>
101
104
  </aside>
102
105
  <div class="tsd-comment tsd-typography">
@@ -106,12 +109,12 @@
106
109
  </div>
107
110
  </section>
108
111
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
109
- <a name="tunnel_sessions" class="tsd-anchor"></a>
110
- <h3>tunnel_<wbr>sessions</h3>
111
- <div class="tsd-signature tsd-kind-icon">tunnel_<wbr>sessions<span class="tsd-signature-symbol">:</span> <a href="tunnelsession.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSession</a><span class="tsd-signature-symbol">[]</span></div>
112
+ <a name="tunnelSessions" class="tsd-anchor"></a>
113
+ <h3>tunnel<wbr>Sessions</h3>
114
+ <div class="tsd-signature tsd-kind-icon">tunnel<wbr>Sessions<span class="tsd-signature-symbol">:</span> <a href="datatypes.TunnelSession.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSession</a><span class="tsd-signature-symbol">[]</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#L1840">types.ts:1840</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1903">datatypes.ts:1903</a></li>
115
118
  </ul>
116
119
  </aside>
117
120
  <div class="tsd-comment tsd-typography">
@@ -126,7 +129,7 @@
126
129
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
127
130
  <aside class="tsd-sources">
128
131
  <ul>
129
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1842">types.ts:1842</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1905">datatypes.ts:1905</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="tunnelsessionlist.html" class="tsd-kind-icon">Tunnel<wbr>Session<wbr>List</a>
164
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
165
+ <a href="datatypes.TunnelSessionList.html" class="tsd-kind-icon">Tunnel<wbr>Session<wbr>List</a>
154
166
  <ul>
155
167
  <li class=" tsd-kind-property tsd-parent-kind-interface">
156
- <a href="tunnelsessionlist.html#next_page_uri" class="tsd-kind-icon">next_<wbr>page_<wbr>uri</a>
168
+ <a href="datatypes.TunnelSessionList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a>
157
169
  </li>
158
170
  <li class=" tsd-kind-property tsd-parent-kind-interface">
159
- <a href="tunnelsessionlist.html#tunnel_sessions" class="tsd-kind-icon">tunnel_<wbr>sessions</a>
171
+ <a href="datatypes.TunnelSessionList.html#tunnelSessions" class="tsd-kind-icon">tunnel<wbr>Sessions</a>
160
172
  </li>
161
173
  <li class=" tsd-kind-property tsd-parent-kind-interface">
162
- <a href="tunnelsessionlist.html#uri" class="tsd-kind-icon">uri</a>
174
+ <a href="datatypes.TunnelSessionList.html#uri" class="tsd-kind-icon">uri</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/{tunnelsessionsupdate.html → datatypes.TunnelSessionsUpdate.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="tunnelsessionsupdate.html">TunnelSessionsUpdate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.TunnelSessionsUpdate.html">TunnelSessionsUpdate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface TunnelSessionsUpdate</h1>
@@ -80,7 +83,7 @@
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="tunnelsessionsupdate.html#id" class="tsd-kind-icon">id</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TunnelSessionsUpdate.html#id" class="tsd-kind-icon">id</a></li>
84
87
  </ul>
85
88
  </section>
86
89
  </div>
@@ -94,7 +97,7 @@
94
97
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
95
98
  <aside class="tsd-sources">
96
99
  <ul>
97
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1848">types.ts:1848</a></li>
100
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1911">datatypes.ts:1911</a></li>
98
101
  </ul>
99
102
  </aside>
100
103
  </section>
@@ -104,7 +107,16 @@
104
107
  <nav class="tsd-navigation primary">
105
108
  <ul>
106
109
  <li class=" ">
107
- <a href="../modules.html">Exports</a>
110
+ <a href="../modules.html">Modules</a>
111
+ </li>
112
+ <li class=" tsd-kind-module">
113
+ <a href="../modules/client.html">client</a>
114
+ </li>
115
+ <li class="current tsd-kind-module">
116
+ <a href="../modules/datatypes.html">datatypes</a>
117
+ </li>
118
+ <li class=" tsd-kind-module">
119
+ <a href="../modules/services.html">services</a>
108
120
  </li>
109
121
  </ul>
110
122
  </nav>
@@ -112,11 +124,11 @@
112
124
  <ul class="before-current">
113
125
  </ul>
114
126
  <ul class="current">
115
- <li class="current tsd-kind-interface">
116
- <a href="tunnelsessionsupdate.html" class="tsd-kind-icon">Tunnel<wbr>Sessions<wbr>Update</a>
127
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
128
+ <a href="datatypes.TunnelSessionsUpdate.html" class="tsd-kind-icon">Tunnel<wbr>Sessions<wbr>Update</a>
117
129
  <ul>
118
130
  <li class=" tsd-kind-property tsd-parent-kind-interface">
119
- <a href="tunnelsessionsupdate.html#id" class="tsd-kind-icon">id</a>
131
+ <a href="datatypes.TunnelSessionsUpdate.html#id" class="tsd-kind-icon">id</a>
120
132
  </li>
121
133
  </ul>
122
134
  </li>
@@ -132,11 +144,11 @@
132
144
  <h2>Legend</h2>
133
145
  <div class="tsd-legend-group">
134
146
  <ul class="tsd-legend">
135
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
136
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
147
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
148
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
137
149
  </ul>
138
150
  <ul class="tsd-legend">
139
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
151
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
140
152
  </ul>
141
153
  </div>
142
154
  </div>