@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/{eventsourceitem.html → datatypes.EventSourceItem.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="eventsourceitem.html">EventSourceItem</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EventSourceItem.html">EventSourceItem</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EventSourceItem</h1>
@@ -87,8 +90,8 @@
87
90
  <section class="tsd-index-section ">
88
91
  <h3>Properties</h3>
89
92
  <ul class="tsd-index-list">
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventsourceitem.html#subscription_id" class="tsd-kind-icon">subscription_<wbr>id</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventsourceitem.html#type" class="tsd-kind-icon">type</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventSourceItem.html#subscriptionId" class="tsd-kind-icon">subscription<wbr>Id</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventSourceItem.html#type" class="tsd-kind-icon">type</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="subscription_id" class="tsd-anchor"></a>
101
- <h3>subscription_<wbr>id</h3>
102
- <div class="tsd-signature tsd-kind-icon">subscription_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
103
+ <a name="subscriptionId" class="tsd-anchor"></a>
104
+ <h3>subscription<wbr>Id</h3>
105
+ <div class="tsd-signature tsd-kind-icon">subscription<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#L1087">types.ts:1087</a></li>
108
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1291">datatypes.ts:1291</a></li>
106
109
  </ul>
107
110
  </aside>
108
111
  <div class="tsd-comment tsd-typography">
@@ -117,7 +120,7 @@
117
120
  <div class="tsd-signature tsd-kind-icon">type<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#L1089">types.ts:1089</a></li>
123
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1293">datatypes.ts:1293</a></li>
121
124
  </ul>
122
125
  </aside>
123
126
  <div class="tsd-comment tsd-typography">
@@ -132,7 +135,16 @@
132
135
  <nav class="tsd-navigation primary">
133
136
  <ul>
134
137
  <li class=" ">
135
- <a href="../modules.html">Exports</a>
138
+ <a href="../modules.html">Modules</a>
139
+ </li>
140
+ <li class=" tsd-kind-module">
141
+ <a href="../modules/client.html">client</a>
142
+ </li>
143
+ <li class="current tsd-kind-module">
144
+ <a href="../modules/datatypes.html">datatypes</a>
145
+ </li>
146
+ <li class=" tsd-kind-module">
147
+ <a href="../modules/services.html">services</a>
136
148
  </li>
137
149
  </ul>
138
150
  </nav>
@@ -140,14 +152,14 @@
140
152
  <ul class="before-current">
141
153
  </ul>
142
154
  <ul class="current">
143
- <li class="current tsd-kind-interface">
144
- <a href="eventsourceitem.html" class="tsd-kind-icon">Event<wbr>Source<wbr>Item</a>
155
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
156
+ <a href="datatypes.EventSourceItem.html" class="tsd-kind-icon">Event<wbr>Source<wbr>Item</a>
145
157
  <ul>
146
158
  <li class=" tsd-kind-property tsd-parent-kind-interface">
147
- <a href="eventsourceitem.html#subscription_id" class="tsd-kind-icon">subscription_<wbr>id</a>
159
+ <a href="datatypes.EventSourceItem.html#subscriptionId" class="tsd-kind-icon">subscription<wbr>Id</a>
148
160
  </li>
149
161
  <li class=" tsd-kind-property tsd-parent-kind-interface">
150
- <a href="eventsourceitem.html#type" class="tsd-kind-icon">type</a>
162
+ <a href="datatypes.EventSourceItem.html#type" class="tsd-kind-icon">type</a>
151
163
  </li>
152
164
  </ul>
153
165
  </li>
@@ -163,11 +175,11 @@
163
175
  <h2>Legend</h2>
164
176
  <div class="tsd-legend-group">
165
177
  <ul class="tsd-legend">
166
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
167
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
178
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
179
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
168
180
  </ul>
169
181
  <ul class="tsd-legend">
170
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
182
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
171
183
  </ul>
172
184
  </div>
173
185
  </div>
package/docs/interfaces/{eventsourcelist.html → datatypes.EventSourceList.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="eventsourcelist.html">EventSourceList</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EventSourceList.html">EventSourceList</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EventSourceList</h1>
@@ -80,8 +83,8 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventsourcelist.html#sources" class="tsd-kind-icon">sources</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventsourcelist.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventSourceList.html#sources" class="tsd-kind-icon">sources</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventSourceList.html#uri" class="tsd-kind-icon">uri</a></li>
85
88
  </ul>
86
89
  </section>
87
90
  </div>
@@ -92,10 +95,10 @@
92
95
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
93
96
  <a name="sources" class="tsd-anchor"></a>
94
97
  <h3>sources</h3>
95
- <div class="tsd-signature tsd-kind-icon">sources<span class="tsd-signature-symbol">:</span> <a href="eventsource.html" class="tsd-signature-type" data-tsd-kind="Interface">EventSource</a><span class="tsd-signature-symbol">[]</span></div>
98
+ <div class="tsd-signature tsd-kind-icon">sources<span class="tsd-signature-symbol">:</span> <a href="datatypes.EventSource.html" class="tsd-signature-type" data-tsd-kind="Interface">EventSource</a><span class="tsd-signature-symbol">[]</span></div>
96
99
  <aside class="tsd-sources">
97
100
  <ul>
98
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1065">types.ts:1065</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1269">datatypes.ts:1269</a></li>
99
102
  </ul>
100
103
  </aside>
101
104
  <div class="tsd-comment tsd-typography">
@@ -110,7 +113,7 @@
110
113
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
111
114
  <aside class="tsd-sources">
112
115
  <ul>
113
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1067">types.ts:1067</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1271">datatypes.ts:1271</a></li>
114
117
  </ul>
115
118
  </aside>
116
119
  <div class="tsd-comment tsd-typography">
@@ -125,7 +128,16 @@
125
128
  <nav class="tsd-navigation primary">
126
129
  <ul>
127
130
  <li class=" ">
128
- <a href="../modules.html">Exports</a>
131
+ <a href="../modules.html">Modules</a>
132
+ </li>
133
+ <li class=" tsd-kind-module">
134
+ <a href="../modules/client.html">client</a>
135
+ </li>
136
+ <li class="current tsd-kind-module">
137
+ <a href="../modules/datatypes.html">datatypes</a>
138
+ </li>
139
+ <li class=" tsd-kind-module">
140
+ <a href="../modules/services.html">services</a>
129
141
  </li>
130
142
  </ul>
131
143
  </nav>
@@ -133,14 +145,14 @@
133
145
  <ul class="before-current">
134
146
  </ul>
135
147
  <ul class="current">
136
- <li class="current tsd-kind-interface">
137
- <a href="eventsourcelist.html" class="tsd-kind-icon">Event<wbr>Source<wbr>List</a>
148
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
149
+ <a href="datatypes.EventSourceList.html" class="tsd-kind-icon">Event<wbr>Source<wbr>List</a>
138
150
  <ul>
139
151
  <li class=" tsd-kind-property tsd-parent-kind-interface">
140
- <a href="eventsourcelist.html#sources" class="tsd-kind-icon">sources</a>
152
+ <a href="datatypes.EventSourceList.html#sources" class="tsd-kind-icon">sources</a>
141
153
  </li>
142
154
  <li class=" tsd-kind-property tsd-parent-kind-interface">
143
- <a href="eventsourcelist.html#uri" class="tsd-kind-icon">uri</a>
155
+ <a href="datatypes.EventSourceList.html#uri" class="tsd-kind-icon">uri</a>
144
156
  </li>
145
157
  </ul>
146
158
  </li>
@@ -156,11 +168,11 @@
156
168
  <h2>Legend</h2>
157
169
  <div class="tsd-legend-group">
158
170
  <ul class="tsd-legend">
159
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
160
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
171
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
172
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
161
173
  </ul>
162
174
  <ul class="tsd-legend">
163
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
175
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
164
176
  </ul>
165
177
  </div>
166
178
  </div>
package/docs/interfaces/{eventsourcepaging.html → datatypes.EventSourcePaging.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="eventsourcepaging.html">EventSourcePaging</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EventSourcePaging.html">EventSourcePaging</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EventSourcePaging</h1>
@@ -87,7 +90,7 @@
87
90
  <section class="tsd-index-section ">
88
91
  <h3>Properties</h3>
89
92
  <ul class="tsd-index-list">
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventsourcepaging.html#subscription_id" class="tsd-kind-icon">subscription_<wbr>id</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventSourcePaging.html#subscriptionId" class="tsd-kind-icon">subscription<wbr>Id</a></li>
91
94
  </ul>
92
95
  </section>
93
96
  </div>
@@ -96,12 +99,12 @@
96
99
  <section class="tsd-panel-group tsd-member-group ">
97
100
  <h2>Properties</h2>
98
101
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
99
- <a name="subscription_id" class="tsd-anchor"></a>
100
- <h3>subscription_<wbr>id</h3>
101
- <div class="tsd-signature tsd-kind-icon">subscription_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
102
+ <a name="subscriptionId" class="tsd-anchor"></a>
103
+ <h3>subscription<wbr>Id</h3>
104
+ <div class="tsd-signature tsd-kind-icon">subscription<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
102
105
  <aside class="tsd-sources">
103
106
  <ul>
104
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1095">types.ts:1095</a></li>
107
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1299">datatypes.ts:1299</a></li>
105
108
  </ul>
106
109
  </aside>
107
110
  <div class="tsd-comment tsd-typography">
@@ -116,7 +119,16 @@
116
119
  <nav class="tsd-navigation primary">
117
120
  <ul>
118
121
  <li class=" ">
119
- <a href="../modules.html">Exports</a>
122
+ <a href="../modules.html">Modules</a>
123
+ </li>
124
+ <li class=" tsd-kind-module">
125
+ <a href="../modules/client.html">client</a>
126
+ </li>
127
+ <li class="current tsd-kind-module">
128
+ <a href="../modules/datatypes.html">datatypes</a>
129
+ </li>
130
+ <li class=" tsd-kind-module">
131
+ <a href="../modules/services.html">services</a>
120
132
  </li>
121
133
  </ul>
122
134
  </nav>
@@ -124,11 +136,11 @@
124
136
  <ul class="before-current">
125
137
  </ul>
126
138
  <ul class="current">
127
- <li class="current tsd-kind-interface">
128
- <a href="eventsourcepaging.html" class="tsd-kind-icon">Event<wbr>Source<wbr>Paging</a>
139
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
140
+ <a href="datatypes.EventSourcePaging.html" class="tsd-kind-icon">Event<wbr>Source<wbr>Paging</a>
129
141
  <ul>
130
142
  <li class=" tsd-kind-property tsd-parent-kind-interface">
131
- <a href="eventsourcepaging.html#subscription_id" class="tsd-kind-icon">subscription_<wbr>id</a>
143
+ <a href="datatypes.EventSourcePaging.html#subscriptionId" class="tsd-kind-icon">subscription<wbr>Id</a>
132
144
  </li>
133
145
  </ul>
134
146
  </li>
@@ -144,11 +156,11 @@
144
156
  <h2>Legend</h2>
145
157
  <div class="tsd-legend-group">
146
158
  <ul class="tsd-legend">
147
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
148
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
159
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
160
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
149
161
  </ul>
150
162
  <ul class="tsd-legend">
151
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
163
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
152
164
  </ul>
153
165
  </div>
154
166
  </div>
package/docs/interfaces/{eventsourcereplace.html → datatypes.EventSourceReplace.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="eventsourcereplace.html">EventSourceReplace</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EventSourceReplace.html">EventSourceReplace</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EventSourceReplace</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="eventsourcereplace.html#type" class="tsd-kind-icon">type</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventSourceReplace.html#type" class="tsd-kind-icon">type</a></li>
84
87
  </ul>
85
88
  </section>
86
89
  </div>
@@ -94,7 +97,7 @@
94
97
  <div class="tsd-signature tsd-kind-icon">type<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#L1053">types.ts:1053</a></li>
100
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1257">datatypes.ts:1257</a></li>
98
101
  </ul>
99
102
  </aside>
100
103
  <div class="tsd-comment tsd-typography">
@@ -109,7 +112,16 @@
109
112
  <nav class="tsd-navigation primary">
110
113
  <ul>
111
114
  <li class=" ">
112
- <a href="../modules.html">Exports</a>
115
+ <a href="../modules.html">Modules</a>
116
+ </li>
117
+ <li class=" tsd-kind-module">
118
+ <a href="../modules/client.html">client</a>
119
+ </li>
120
+ <li class="current tsd-kind-module">
121
+ <a href="../modules/datatypes.html">datatypes</a>
122
+ </li>
123
+ <li class=" tsd-kind-module">
124
+ <a href="../modules/services.html">services</a>
113
125
  </li>
114
126
  </ul>
115
127
  </nav>
@@ -117,11 +129,11 @@
117
129
  <ul class="before-current">
118
130
  </ul>
119
131
  <ul class="current">
120
- <li class="current tsd-kind-interface">
121
- <a href="eventsourcereplace.html" class="tsd-kind-icon">Event<wbr>Source<wbr>Replace</a>
132
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
133
+ <a href="datatypes.EventSourceReplace.html" class="tsd-kind-icon">Event<wbr>Source<wbr>Replace</a>
122
134
  <ul>
123
135
  <li class=" tsd-kind-property tsd-parent-kind-interface">
124
- <a href="eventsourcereplace.html#type" class="tsd-kind-icon">type</a>
136
+ <a href="datatypes.EventSourceReplace.html#type" class="tsd-kind-icon">type</a>
125
137
  </li>
126
138
  </ul>
127
139
  </li>
@@ -137,11 +149,11 @@
137
149
  <h2>Legend</h2>
138
150
  <div class="tsd-legend-group">
139
151
  <ul class="tsd-legend">
140
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
141
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
152
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
153
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
142
154
  </ul>
143
155
  <ul class="tsd-legend">
144
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
156
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
145
157
  </ul>
146
158
  </div>
147
159
  </div>
package/docs/interfaces/{eventsourceupdate.html → datatypes.EventSourceUpdate.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="eventsourceupdate.html">EventSourceUpdate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EventSourceUpdate.html">EventSourceUpdate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EventSourceUpdate</h1>
@@ -80,8 +83,8 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventsourceupdate.html#subscription_id" class="tsd-kind-icon">subscription_<wbr>id</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventsourceupdate.html#type" class="tsd-kind-icon">type</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventSourceUpdate.html#subscriptionId" class="tsd-kind-icon">subscription<wbr>Id</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventSourceUpdate.html#type" class="tsd-kind-icon">type</a></li>
85
88
  </ul>
86
89
  </section>
87
90
  </div>
@@ -90,12 +93,12 @@
90
93
  <section class="tsd-panel-group tsd-member-group ">
91
94
  <h2>Properties</h2>
92
95
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
93
- <a name="subscription_id" class="tsd-anchor"></a>
94
- <h3>subscription_<wbr>id</h3>
95
- <div class="tsd-signature tsd-kind-icon">subscription_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
96
+ <a name="subscriptionId" class="tsd-anchor"></a>
97
+ <h3>subscription<wbr>Id</h3>
98
+ <div class="tsd-signature tsd-kind-icon">subscription<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
96
99
  <aside class="tsd-sources">
97
100
  <ul>
98
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1079">types.ts:1079</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1283">datatypes.ts:1283</a></li>
99
102
  </ul>
100
103
  </aside>
101
104
  <div class="tsd-comment tsd-typography">
@@ -110,7 +113,7 @@
110
113
  <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
111
114
  <aside class="tsd-sources">
112
115
  <ul>
113
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1081">types.ts:1081</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1285">datatypes.ts:1285</a></li>
114
117
  </ul>
115
118
  </aside>
116
119
  <div class="tsd-comment tsd-typography">
@@ -125,7 +128,16 @@
125
128
  <nav class="tsd-navigation primary">
126
129
  <ul>
127
130
  <li class=" ">
128
- <a href="../modules.html">Exports</a>
131
+ <a href="../modules.html">Modules</a>
132
+ </li>
133
+ <li class=" tsd-kind-module">
134
+ <a href="../modules/client.html">client</a>
135
+ </li>
136
+ <li class="current tsd-kind-module">
137
+ <a href="../modules/datatypes.html">datatypes</a>
138
+ </li>
139
+ <li class=" tsd-kind-module">
140
+ <a href="../modules/services.html">services</a>
129
141
  </li>
130
142
  </ul>
131
143
  </nav>
@@ -133,14 +145,14 @@
133
145
  <ul class="before-current">
134
146
  </ul>
135
147
  <ul class="current">
136
- <li class="current tsd-kind-interface">
137
- <a href="eventsourceupdate.html" class="tsd-kind-icon">Event<wbr>Source<wbr>Update</a>
148
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
149
+ <a href="datatypes.EventSourceUpdate.html" class="tsd-kind-icon">Event<wbr>Source<wbr>Update</a>
138
150
  <ul>
139
151
  <li class=" tsd-kind-property tsd-parent-kind-interface">
140
- <a href="eventsourceupdate.html#subscription_id" class="tsd-kind-icon">subscription_<wbr>id</a>
152
+ <a href="datatypes.EventSourceUpdate.html#subscriptionId" class="tsd-kind-icon">subscription<wbr>Id</a>
141
153
  </li>
142
154
  <li class=" tsd-kind-property tsd-parent-kind-interface">
143
- <a href="eventsourceupdate.html#type" class="tsd-kind-icon">type</a>
155
+ <a href="datatypes.EventSourceUpdate.html#type" class="tsd-kind-icon">type</a>
144
156
  </li>
145
157
  </ul>
146
158
  </li>
@@ -156,11 +168,11 @@
156
168
  <h2>Legend</h2>
157
169
  <div class="tsd-legend-group">
158
170
  <ul class="tsd-legend">
159
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
160
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
171
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
172
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
161
173
  </ul>
162
174
  <ul class="tsd-legend">
163
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
175
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
164
176
  </ul>
165
177
  </div>
166
178
  </div>