@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/{endpointwebhookvalidation.html → datatypes.EndpointWebhookValidation.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="endpointwebhookvalidation.html">EndpointWebhookValidation</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointWebhookValidation.html">EndpointWebhookValidation</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointWebhookValidation</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="endpointwebhookvalidation.html#enabled" class="tsd-kind-icon">enabled</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointwebhookvalidation.html#provider" class="tsd-kind-icon">provider</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointwebhookvalidation.html#secret" class="tsd-kind-icon">secret</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointWebhookValidation.html#enabled" class="tsd-kind-icon">enabled</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointWebhookValidation.html#provider" class="tsd-kind-icon">provider</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointWebhookValidation.html#secret" class="tsd-kind-icon">secret</a></li>
86
89
  </ul>
87
90
  </section>
88
91
  </div>
@@ -96,12 +99,12 @@
96
99
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
97
100
  <aside class="tsd-sources">
98
101
  <ul>
99
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L484">types.ts:484</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L422">datatypes.ts:422</a></li>
100
103
  </ul>
101
104
  </aside>
102
105
  <div class="tsd-comment tsd-typography">
103
106
  <div class="lead">
104
- <p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
107
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
105
108
  </div>
106
109
  </div>
107
110
  </section>
@@ -111,12 +114,12 @@
111
114
  <div class="tsd-signature tsd-kind-icon">provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
112
115
  <aside class="tsd-sources">
113
116
  <ul>
114
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L486">types.ts:486</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L424">datatypes.ts:424</a></li>
115
118
  </ul>
116
119
  </aside>
117
120
  <div class="tsd-comment tsd-typography">
118
121
  <div class="lead">
119
- <p>a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: SLACK, SNS, STRIPE, GITHUB, TWILIO, SHOPIFY, GITLAB, INTERCOM.</p>
122
+ <p>a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: <code>SLACK</code>, <code>SNS</code>, <code>STRIPE</code>, <code>GITHUB</code>, <code>TWILIO</code>, <code>SHOPIFY</code>, <code>GITLAB</code>, <code>INTERCOM</code>, <code>SENDGRID</code>, <code>XERO</code>, <code>PAGERDUTY</code>.</p>
120
123
  </div>
121
124
  </div>
122
125
  </section>
@@ -126,7 +129,7 @@
126
129
  <div class="tsd-signature tsd-kind-icon">secret<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#L488">types.ts:488</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L426">datatypes.ts:426</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="endpointwebhookvalidation.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation</a>
164
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
165
+ <a href="datatypes.EndpointWebhookValidation.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation</a>
154
166
  <ul>
155
167
  <li class=" tsd-kind-property tsd-parent-kind-interface">
156
- <a href="endpointwebhookvalidation.html#enabled" class="tsd-kind-icon">enabled</a>
168
+ <a href="datatypes.EndpointWebhookValidation.html#enabled" class="tsd-kind-icon">enabled</a>
157
169
  </li>
158
170
  <li class=" tsd-kind-property tsd-parent-kind-interface">
159
- <a href="endpointwebhookvalidation.html#provider" class="tsd-kind-icon">provider</a>
171
+ <a href="datatypes.EndpointWebhookValidation.html#provider" class="tsd-kind-icon">provider</a>
160
172
  </li>
161
173
  <li class=" tsd-kind-property tsd-parent-kind-interface">
162
- <a href="endpointwebhookvalidation.html#secret" class="tsd-kind-icon">secret</a>
174
+ <a href="datatypes.EndpointWebhookValidation.html#secret" class="tsd-kind-icon">secret</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/{staticbackendtls.html → datatypes.EndpointWebsocketTCPConverter.html} RENAMED
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta charset="utf-8">
5
5
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>StaticBackendTLS | @ngrok/ngrok-api</title>
6
+ <title>EndpointWebsocketTCPConverter | @ngrok/ngrok-api</title>
7
7
  <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
8
  <meta name="viewport" content="width=device-width, initial-scale=1">
9
9
  <link rel="stylesheet" href="../assets/css/main.css">
@@ -55,10 +55,13 @@
55
55
  <a href="../modules.html">@ngrok/ngrok-api</a>
56
56
  </li>
57
57
  <li>
58
- <a href="staticbackendtls.html">StaticBackendTLS</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointWebsocketTCPConverter.html">EndpointWebsocketTCPConverter</a>
59
62
  </li>
60
63
  </ul>
61
- <h1>Interface StaticBackendTLS</h1>
64
+ <h1>Interface EndpointWebsocketTCPConverter</h1>
62
65
  </div>
63
66
  </div>
64
67
  </header>
@@ -69,7 +72,7 @@
69
72
  <h3>Hierarchy</h3>
70
73
  <ul class="tsd-hierarchy">
71
74
  <li>
72
- <span class="target">StaticBackendTLS</span>
75
+ <span class="target">EndpointWebsocketTCPConverter</span>
73
76
  </li>
74
77
  </ul>
75
78
  </section>
@@ -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="staticbackendtls.html#enabled" class="tsd-kind-icon">enabled</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointWebsocketTCPConverter.html#enabled" class="tsd-kind-icon">enabled</a></li>
84
87
  </ul>
85
88
  </section>
86
89
  </div>
@@ -90,16 +93,16 @@
90
93
  <h2>Properties</h2>
91
94
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
92
95
  <a name="enabled" class="tsd-anchor"></a>
93
- <h3>enabled</h3>
96
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> enabled</h3>
94
97
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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#L155">types.ts:155</a></li>
100
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L687">datatypes.ts:687</a></li>
98
101
  </ul>
99
102
  </aside>
100
103
  <div class="tsd-comment tsd-typography">
101
104
  <div class="lead">
102
- <p>if tls is checked</p>
105
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
103
106
  </div>
104
107
  </div>
105
108
  </section>
@@ -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="staticbackendtls.html" class="tsd-kind-icon">Static<wbr>BackendTLS</a>
132
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
133
+ <a href="datatypes.EndpointWebsocketTCPConverter.html" class="tsd-kind-icon">Endpoint<wbr>WebsocketTCPConverter</a>
122
134
  <ul>
123
135
  <li class=" tsd-kind-property tsd-parent-kind-interface">
124
- <a href="staticbackendtls.html#enabled" class="tsd-kind-icon">enabled</a>
136
+ <a href="datatypes.EndpointWebsocketTCPConverter.html#enabled" class="tsd-kind-icon">enabled</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/{error.html → datatypes.Error.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="error.html">Error</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.Error.html">Error</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface Error</h1>
@@ -80,10 +83,10 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="error.html#details" class="tsd-kind-icon">details</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="error.html#error_code" class="tsd-kind-icon">error_<wbr>code</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="error.html#msg" class="tsd-kind-icon">msg</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="error.html#status_code" class="tsd-kind-icon">status_<wbr>code</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Error.html#details" class="tsd-kind-icon">details</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Error.html#errorCode" class="tsd-kind-icon">error<wbr>Code</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Error.html#msg" class="tsd-kind-icon">msg</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Error.html#statusCode" class="tsd-kind-icon">status<wbr>Code</a></li>
87
90
  </ul>
88
91
  </section>
89
92
  </div>
@@ -97,17 +100,17 @@
97
100
  <div class="tsd-signature tsd-kind-icon">details<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
98
101
  <aside class="tsd-sources">
99
102
  <ul>
100
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L17">types.ts:17</a></li>
103
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L17">datatypes.ts:17</a></li>
101
104
  </ul>
102
105
  </aside>
103
106
  </section>
104
107
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
105
- <a name="error_code" class="tsd-anchor"></a>
106
- <h3>error_<wbr>code</h3>
107
- <div class="tsd-signature tsd-kind-icon">error_<wbr>code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
108
+ <a name="errorCode" class="tsd-anchor"></a>
109
+ <h3>error<wbr>Code</h3>
110
+ <div class="tsd-signature tsd-kind-icon">error<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
108
111
  <aside class="tsd-sources">
109
112
  <ul>
110
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L14">types.ts:14</a></li>
113
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L14">datatypes.ts:14</a></li>
111
114
  </ul>
112
115
  </aside>
113
116
  </section>
@@ -117,17 +120,17 @@
117
120
  <div class="tsd-signature tsd-kind-icon">msg<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#L16">types.ts:16</a></li>
123
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L16">datatypes.ts:16</a></li>
121
124
  </ul>
122
125
  </aside>
123
126
  </section>
124
127
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
125
- <a name="status_code" class="tsd-anchor"></a>
126
- <h3>status_<wbr>code</h3>
127
- <div class="tsd-signature tsd-kind-icon">status_<wbr>code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
128
+ <a name="statusCode" class="tsd-anchor"></a>
129
+ <h3>status<wbr>Code</h3>
130
+ <div class="tsd-signature tsd-kind-icon">status<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
128
131
  <aside class="tsd-sources">
129
132
  <ul>
130
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L15">types.ts:15</a></li>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L15">datatypes.ts:15</a></li>
131
134
  </ul>
132
135
  </aside>
133
136
  </section>
@@ -137,7 +140,16 @@
137
140
  <nav class="tsd-navigation primary">
138
141
  <ul>
139
142
  <li class=" ">
140
- <a href="../modules.html">Exports</a>
143
+ <a href="../modules.html">Modules</a>
144
+ </li>
145
+ <li class=" tsd-kind-module">
146
+ <a href="../modules/client.html">client</a>
147
+ </li>
148
+ <li class="current tsd-kind-module">
149
+ <a href="../modules/datatypes.html">datatypes</a>
150
+ </li>
151
+ <li class=" tsd-kind-module">
152
+ <a href="../modules/services.html">services</a>
141
153
  </li>
142
154
  </ul>
143
155
  </nav>
@@ -145,20 +157,20 @@
145
157
  <ul class="before-current">
146
158
  </ul>
147
159
  <ul class="current">
148
- <li class="current tsd-kind-interface">
149
- <a href="error.html" class="tsd-kind-icon">Error</a>
160
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
161
+ <a href="datatypes.Error.html" class="tsd-kind-icon">Error</a>
150
162
  <ul>
151
163
  <li class=" tsd-kind-property tsd-parent-kind-interface">
152
- <a href="error.html#details" class="tsd-kind-icon">details</a>
164
+ <a href="datatypes.Error.html#details" class="tsd-kind-icon">details</a>
153
165
  </li>
154
166
  <li class=" tsd-kind-property tsd-parent-kind-interface">
155
- <a href="error.html#error_code" class="tsd-kind-icon">error_<wbr>code</a>
167
+ <a href="datatypes.Error.html#errorCode" class="tsd-kind-icon">error<wbr>Code</a>
156
168
  </li>
157
169
  <li class=" tsd-kind-property tsd-parent-kind-interface">
158
- <a href="error.html#msg" class="tsd-kind-icon">msg</a>
170
+ <a href="datatypes.Error.html#msg" class="tsd-kind-icon">msg</a>
159
171
  </li>
160
172
  <li class=" tsd-kind-property tsd-parent-kind-interface">
161
- <a href="error.html#status_code" class="tsd-kind-icon">status_<wbr>code</a>
173
+ <a href="datatypes.Error.html#statusCode" class="tsd-kind-icon">status<wbr>Code</a>
162
174
  </li>
163
175
  </ul>
164
176
  </li>
@@ -174,11 +186,11 @@
174
186
  <h2>Legend</h2>
175
187
  <div class="tsd-legend-group">
176
188
  <ul class="tsd-legend">
177
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
178
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
189
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
190
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
179
191
  </ul>
180
192
  <ul class="tsd-legend">
181
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
193
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
182
194
  </ul>
183
195
  </div>
184
196
  </div>
package/docs/interfaces/{eventdestination.html → datatypes.EventDestination.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="eventdestination.html">EventDestination</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EventDestination.html">EventDestination</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EventDestination</h1>
@@ -80,13 +83,13 @@
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="eventdestination.html#created_at" class="tsd-kind-icon">created_<wbr>at</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventdestination.html#description" class="tsd-kind-icon">description</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventdestination.html#format" class="tsd-kind-icon">format</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventdestination.html#id" class="tsd-kind-icon">id</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventdestination.html#metadata" class="tsd-kind-icon">metadata</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventdestination.html#target" class="tsd-kind-icon">target</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="eventdestination.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventDestination.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventDestination.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventDestination.html#format" class="tsd-kind-icon">format</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventDestination.html#id" class="tsd-kind-icon">id</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventDestination.html#metadata" class="tsd-kind-icon">metadata</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventDestination.html#target" class="tsd-kind-icon">target</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventDestination.html#uri" class="tsd-kind-icon">uri</a></li>
90
93
  </ul>
91
94
  </section>
92
95
  </div>
@@ -95,12 +98,12 @@
95
98
  <section class="tsd-panel-group tsd-member-group ">
96
99
  <h2>Properties</h2>
97
100
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
98
- <a name="created_at" class="tsd-anchor"></a>
99
- <h3>created_<wbr>at</h3>
100
- <div class="tsd-signature tsd-kind-icon">created_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
101
+ <a name="createdAt" class="tsd-anchor"></a>
102
+ <h3>created<wbr>At</h3>
103
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
101
104
  <aside class="tsd-sources">
102
105
  <ul>
103
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L911">types.ts:911</a></li>
106
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1136">datatypes.ts:1136</a></li>
104
107
  </ul>
105
108
  </aside>
106
109
  <div class="tsd-comment tsd-typography">
@@ -115,7 +118,7 @@
115
118
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
116
119
  <aside class="tsd-sources">
117
120
  <ul>
118
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L913">types.ts:913</a></li>
121
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1138">datatypes.ts:1138</a></li>
119
122
  </ul>
120
123
  </aside>
121
124
  <div class="tsd-comment tsd-typography">
@@ -130,12 +133,12 @@
130
133
  <div class="tsd-signature tsd-kind-icon">format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
131
134
  <aside class="tsd-sources">
132
135
  <ul>
133
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L915">types.ts:915</a></li>
136
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1140">datatypes.ts:1140</a></li>
134
137
  </ul>
135
138
  </aside>
136
139
  <div class="tsd-comment tsd-typography">
137
140
  <div class="lead">
138
- <p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.</p>
141
+ <p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code>JSON</code>.</p>
139
142
  </div>
140
143
  </div>
141
144
  </section>
@@ -145,7 +148,7 @@
145
148
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
146
149
  <aside class="tsd-sources">
147
150
  <ul>
148
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L907">types.ts:907</a></li>
151
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1132">datatypes.ts:1132</a></li>
149
152
  </ul>
150
153
  </aside>
151
154
  <div class="tsd-comment tsd-typography">
@@ -160,7 +163,7 @@
160
163
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
161
164
  <aside class="tsd-sources">
162
165
  <ul>
163
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L909">types.ts:909</a></li>
166
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1134">datatypes.ts:1134</a></li>
164
167
  </ul>
165
168
  </aside>
166
169
  <div class="tsd-comment tsd-typography">
@@ -172,15 +175,15 @@
172
175
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
173
176
  <a name="target" class="tsd-anchor"></a>
174
177
  <h3>target</h3>
175
- <div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">:</span> <a href="eventtarget.html" class="tsd-signature-type" data-tsd-kind="Interface">EventTarget</a></div>
178
+ <div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">:</span> <a href="datatypes.EventTarget.html" class="tsd-signature-type" data-tsd-kind="Interface">EventTarget</a></div>
176
179
  <aside class="tsd-sources">
177
180
  <ul>
178
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L917">types.ts:917</a></li>
181
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1142">datatypes.ts:1142</a></li>
179
182
  </ul>
180
183
  </aside>
181
184
  <div class="tsd-comment tsd-typography">
182
185
  <div class="lead">
183
- <p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.</p>
186
+ <p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code>kinesis</code>, <code>firehose</code>, <code>cloudwatch_logs</code>, or <code>s3</code>.</p>
184
187
  </div>
185
188
  </div>
186
189
  </section>
@@ -190,7 +193,7 @@
190
193
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
191
194
  <aside class="tsd-sources">
192
195
  <ul>
193
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L919">types.ts:919</a></li>
196
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1144">datatypes.ts:1144</a></li>
194
197
  </ul>
195
198
  </aside>
196
199
  <div class="tsd-comment tsd-typography">
@@ -205,7 +208,16 @@
205
208
  <nav class="tsd-navigation primary">
206
209
  <ul>
207
210
  <li class=" ">
208
- <a href="../modules.html">Exports</a>
211
+ <a href="../modules.html">Modules</a>
212
+ </li>
213
+ <li class=" tsd-kind-module">
214
+ <a href="../modules/client.html">client</a>
215
+ </li>
216
+ <li class="current tsd-kind-module">
217
+ <a href="../modules/datatypes.html">datatypes</a>
218
+ </li>
219
+ <li class=" tsd-kind-module">
220
+ <a href="../modules/services.html">services</a>
209
221
  </li>
210
222
  </ul>
211
223
  </nav>
@@ -213,29 +225,29 @@
213
225
  <ul class="before-current">
214
226
  </ul>
215
227
  <ul class="current">
216
- <li class="current tsd-kind-interface">
217
- <a href="eventdestination.html" class="tsd-kind-icon">Event<wbr>Destination</a>
228
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
229
+ <a href="datatypes.EventDestination.html" class="tsd-kind-icon">Event<wbr>Destination</a>
218
230
  <ul>
219
231
  <li class=" tsd-kind-property tsd-parent-kind-interface">
220
- <a href="eventdestination.html#created_at" class="tsd-kind-icon">created_<wbr>at</a>
232
+ <a href="datatypes.EventDestination.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
221
233
  </li>
222
234
  <li class=" tsd-kind-property tsd-parent-kind-interface">
223
- <a href="eventdestination.html#description" class="tsd-kind-icon">description</a>
235
+ <a href="datatypes.EventDestination.html#description" class="tsd-kind-icon">description</a>
224
236
  </li>
225
237
  <li class=" tsd-kind-property tsd-parent-kind-interface">
226
- <a href="eventdestination.html#format" class="tsd-kind-icon">format</a>
238
+ <a href="datatypes.EventDestination.html#format" class="tsd-kind-icon">format</a>
227
239
  </li>
228
240
  <li class=" tsd-kind-property tsd-parent-kind-interface">
229
- <a href="eventdestination.html#id" class="tsd-kind-icon">id</a>
241
+ <a href="datatypes.EventDestination.html#id" class="tsd-kind-icon">id</a>
230
242
  </li>
231
243
  <li class=" tsd-kind-property tsd-parent-kind-interface">
232
- <a href="eventdestination.html#metadata" class="tsd-kind-icon">metadata</a>
244
+ <a href="datatypes.EventDestination.html#metadata" class="tsd-kind-icon">metadata</a>
233
245
  </li>
234
246
  <li class=" tsd-kind-property tsd-parent-kind-interface">
235
- <a href="eventdestination.html#target" class="tsd-kind-icon">target</a>
247
+ <a href="datatypes.EventDestination.html#target" class="tsd-kind-icon">target</a>
236
248
  </li>
237
249
  <li class=" tsd-kind-property tsd-parent-kind-interface">
238
- <a href="eventdestination.html#uri" class="tsd-kind-icon">uri</a>
250
+ <a href="datatypes.EventDestination.html#uri" class="tsd-kind-icon">uri</a>
239
251
  </li>
240
252
  </ul>
241
253
  </li>
@@ -251,11 +263,11 @@
251
263
  <h2>Legend</h2>
252
264
  <div class="tsd-legend-group">
253
265
  <ul class="tsd-legend">
254
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
255
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
266
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
267
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
256
268
  </ul>
257
269
  <ul class="tsd-legend">
258
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
270
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
259
271
  </ul>
260
272
  </div>
261
273
  </div>