@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/{tlscertificate.html → datatypes.TLSCertificate.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="tlscertificate.html">TLSCertificate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.TLSCertificate.html">TLSCertificate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface TLSCertificate</h1>
@@ -80,27 +83,27 @@
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="tlscertificate.html#certificate_pem" class="tsd-kind-icon">certificate_<wbr>pem</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#created_at" class="tsd-kind-icon">created_<wbr>at</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#description" class="tsd-kind-icon">description</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#extended_key_usages" class="tsd-kind-icon">extended_<wbr>key_<wbr>usages</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#id" class="tsd-kind-icon">id</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#issued_at" class="tsd-kind-icon">issued_<wbr>at</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#issuer_common_name" class="tsd-kind-icon">issuer_<wbr>common_<wbr>name</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#key_usages" class="tsd-kind-icon">key_<wbr>usages</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#metadata" class="tsd-kind-icon">metadata</a></li>
92
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#not_after" class="tsd-kind-icon">not_<wbr>after</a></li>
93
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#not_before" class="tsd-kind-icon">not_<wbr>before</a></li>
94
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#private_key_type" class="tsd-kind-icon">private_<wbr>key_<wbr>type</a></li>
95
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#serial_number" class="tsd-kind-icon">serial_<wbr>number</a></li>
96
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#subject_alternative_names" class="tsd-kind-icon">subject_<wbr>alternative_<wbr>names</a></li>
97
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#subject_common_name" class="tsd-kind-icon">subject_<wbr>common_<wbr>name</a></li>
98
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#subject_country" class="tsd-kind-icon">subject_<wbr>country</a></li>
99
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#subject_locality" class="tsd-kind-icon">subject_<wbr>locality</a></li>
100
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#subject_organization" class="tsd-kind-icon">subject_<wbr>organization</a></li>
101
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#subject_organizational_unit" class="tsd-kind-icon">subject_<wbr>organizational_<wbr>unit</a></li>
102
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#subject_province" class="tsd-kind-icon">subject_<wbr>province</a></li>
103
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlscertificate.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#certificatePem" class="tsd-kind-icon">certificate<wbr>Pem</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#description" class="tsd-kind-icon">description</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#extendedKeyUsages" class="tsd-kind-icon">extended<wbr>Key<wbr>Usages</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#id" class="tsd-kind-icon">id</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#issuedAt" class="tsd-kind-icon">issued<wbr>At</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#issuerCommonName" class="tsd-kind-icon">issuer<wbr>Common<wbr>Name</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#keyUsages" class="tsd-kind-icon">key<wbr>Usages</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#metadata" class="tsd-kind-icon">metadata</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#notAfter" class="tsd-kind-icon">not<wbr>After</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#notBefore" class="tsd-kind-icon">not<wbr>Before</a></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#privateKeyType" class="tsd-kind-icon">private<wbr>Key<wbr>Type</a></li>
98
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#serialNumber" class="tsd-kind-icon">serial<wbr>Number</a></li>
99
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#subjectAlternativeNames" class="tsd-kind-icon">subject<wbr>Alternative<wbr>Names</a></li>
100
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#subjectCommonName" class="tsd-kind-icon">subject<wbr>Common<wbr>Name</a></li>
101
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#subjectCountry" class="tsd-kind-icon">subject<wbr>Country</a></li>
102
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#subjectLocality" class="tsd-kind-icon">subject<wbr>Locality</a></li>
103
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#subjectOrganization" class="tsd-kind-icon">subject<wbr>Organization</a></li>
104
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#subjectOrganizationalUnit" class="tsd-kind-icon">subject<wbr>Organizational<wbr>Unit</a></li>
105
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#subjectProvince" class="tsd-kind-icon">subject<wbr>Province</a></li>
106
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSCertificate.html#uri" class="tsd-kind-icon">uri</a></li>
104
107
  </ul>
105
108
  </section>
106
109
  </div>
@@ -109,27 +112,27 @@
109
112
  <section class="tsd-panel-group tsd-member-group ">
110
113
  <h2>Properties</h2>
111
114
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
112
- <a name="certificate_pem" class="tsd-anchor"></a>
113
- <h3>certificate_<wbr>pem</h3>
114
- <div class="tsd-signature tsd-kind-icon">certificate_<wbr>pem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
115
+ <a name="certificatePem" class="tsd-anchor"></a>
116
+ <h3>certificate<wbr>Pem</h3>
117
+ <div class="tsd-signature tsd-kind-icon">certificate<wbr>Pem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
115
118
  <aside class="tsd-sources">
116
119
  <ul>
117
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1766">types.ts:1766</a></li>
120
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1829">datatypes.ts:1829</a></li>
118
121
  </ul>
119
122
  </aside>
120
123
  <div class="tsd-comment tsd-typography">
121
124
  <div class="lead">
122
- <p>chain of PEM-encoded certificates, leaf first. See (<a href="https://ngrok.com/docs/api#tls-certificates-pem)Certificate">https://ngrok.com/docs/api#tls-certificates-pem)Certificate</a> Bundles.</p>
125
+ <p>chain of PEM-encoded certificates, leaf first. See <a href="https://ngrok.com/docs/api#tls-certificates-pem">Certificate Bundles</a>.</p>
123
126
  </div>
124
127
  </div>
125
128
  </section>
126
129
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
127
- <a name="created_at" class="tsd-anchor"></a>
128
- <h3>created_<wbr>at</h3>
129
- <div class="tsd-signature tsd-kind-icon">created_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130
+ <a name="createdAt" class="tsd-anchor"></a>
131
+ <h3>created<wbr>At</h3>
132
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130
133
  <aside class="tsd-sources">
131
134
  <ul>
132
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1760">types.ts:1760</a></li>
135
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1823">datatypes.ts:1823</a></li>
133
136
  </ul>
134
137
  </aside>
135
138
  <div class="tsd-comment tsd-typography">
@@ -144,7 +147,7 @@
144
147
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
145
148
  <aside class="tsd-sources">
146
149
  <ul>
147
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1762">types.ts:1762</a></li>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1825">datatypes.ts:1825</a></li>
148
151
  </ul>
149
152
  </aside>
150
153
  <div class="tsd-comment tsd-typography">
@@ -154,12 +157,12 @@
154
157
  </div>
155
158
  </section>
156
159
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
157
- <a name="extended_key_usages" class="tsd-anchor"></a>
158
- <h3>extended_<wbr>key_<wbr>usages</h3>
159
- <div class="tsd-signature tsd-kind-icon">extended_<wbr>key_<wbr>usages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
160
+ <a name="extendedKeyUsages" class="tsd-anchor"></a>
161
+ <h3>extended<wbr>Key<wbr>Usages</h3>
162
+ <div class="tsd-signature tsd-kind-icon">extended<wbr>Key<wbr>Usages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
160
163
  <aside class="tsd-sources">
161
164
  <ul>
162
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1780">types.ts:1780</a></li>
165
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1843">datatypes.ts:1843</a></li>
163
166
  </ul>
164
167
  </aside>
165
168
  <div class="tsd-comment tsd-typography">
@@ -174,7 +177,7 @@
174
177
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
175
178
  <aside class="tsd-sources">
176
179
  <ul>
177
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1756">types.ts:1756</a></li>
180
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1819">datatypes.ts:1819</a></li>
178
181
  </ul>
179
182
  </aside>
180
183
  <div class="tsd-comment tsd-typography">
@@ -184,12 +187,12 @@
184
187
  </div>
185
188
  </section>
186
189
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
187
- <a name="issued_at" class="tsd-anchor"></a>
188
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> issued_<wbr>at</h3>
189
- <div class="tsd-signature tsd-kind-icon">issued_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
190
+ <a name="issuedAt" class="tsd-anchor"></a>
191
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> issued<wbr>At</h3>
192
+ <div class="tsd-signature tsd-kind-icon">issued<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
190
193
  <aside class="tsd-sources">
191
194
  <ul>
192
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1772">types.ts:1772</a></li>
195
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1835">datatypes.ts:1835</a></li>
193
196
  </ul>
194
197
  </aside>
195
198
  <div class="tsd-comment tsd-typography">
@@ -199,12 +202,12 @@
199
202
  </div>
200
203
  </section>
201
204
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
202
- <a name="issuer_common_name" class="tsd-anchor"></a>
203
- <h3>issuer_<wbr>common_<wbr>name</h3>
204
- <div class="tsd-signature tsd-kind-icon">issuer_<wbr>common_<wbr>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
205
+ <a name="issuerCommonName" class="tsd-anchor"></a>
206
+ <h3>issuer<wbr>Common<wbr>Name</h3>
207
+ <div class="tsd-signature tsd-kind-icon">issuer<wbr>Common<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
205
208
  <aside class="tsd-sources">
206
209
  <ul>
207
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1784">types.ts:1784</a></li>
210
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1847">datatypes.ts:1847</a></li>
208
211
  </ul>
209
212
  </aside>
210
213
  <div class="tsd-comment tsd-typography">
@@ -214,12 +217,12 @@
214
217
  </div>
215
218
  </section>
216
219
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
217
- <a name="key_usages" class="tsd-anchor"></a>
218
- <h3>key_<wbr>usages</h3>
219
- <div class="tsd-signature tsd-kind-icon">key_<wbr>usages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
220
+ <a name="keyUsages" class="tsd-anchor"></a>
221
+ <h3>key<wbr>Usages</h3>
222
+ <div class="tsd-signature tsd-kind-icon">key<wbr>Usages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
220
223
  <aside class="tsd-sources">
221
224
  <ul>
222
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1778">types.ts:1778</a></li>
225
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1841">datatypes.ts:1841</a></li>
223
226
  </ul>
224
227
  </aside>
225
228
  <div class="tsd-comment tsd-typography">
@@ -234,7 +237,7 @@
234
237
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
235
238
  <aside class="tsd-sources">
236
239
  <ul>
237
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1764">types.ts:1764</a></li>
240
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1827">datatypes.ts:1827</a></li>
238
241
  </ul>
239
242
  </aside>
240
243
  <div class="tsd-comment tsd-typography">
@@ -244,12 +247,12 @@
244
247
  </div>
245
248
  </section>
246
249
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
247
- <a name="not_after" class="tsd-anchor"></a>
248
- <h3>not_<wbr>after</h3>
249
- <div class="tsd-signature tsd-kind-icon">not_<wbr>after<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
250
+ <a name="notAfter" class="tsd-anchor"></a>
251
+ <h3>not<wbr>After</h3>
252
+ <div class="tsd-signature tsd-kind-icon">not<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
250
253
  <aside class="tsd-sources">
251
254
  <ul>
252
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1776">types.ts:1776</a></li>
255
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1839">datatypes.ts:1839</a></li>
253
256
  </ul>
254
257
  </aside>
255
258
  <div class="tsd-comment tsd-typography">
@@ -259,12 +262,12 @@
259
262
  </div>
260
263
  </section>
261
264
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
262
- <a name="not_before" class="tsd-anchor"></a>
263
- <h3>not_<wbr>before</h3>
264
- <div class="tsd-signature tsd-kind-icon">not_<wbr>before<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
265
+ <a name="notBefore" class="tsd-anchor"></a>
266
+ <h3>not<wbr>Before</h3>
267
+ <div class="tsd-signature tsd-kind-icon">not<wbr>Before<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
265
268
  <aside class="tsd-sources">
266
269
  <ul>
267
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1774">types.ts:1774</a></li>
270
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1837">datatypes.ts:1837</a></li>
268
271
  </ul>
269
272
  </aside>
270
273
  <div class="tsd-comment tsd-typography">
@@ -274,12 +277,12 @@
274
277
  </div>
275
278
  </section>
276
279
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
277
- <a name="private_key_type" class="tsd-anchor"></a>
278
- <h3>private_<wbr>key_<wbr>type</h3>
279
- <div class="tsd-signature tsd-kind-icon">private_<wbr>key_<wbr>type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
280
+ <a name="privateKeyType" class="tsd-anchor"></a>
281
+ <h3>private<wbr>Key<wbr>Type</h3>
282
+ <div class="tsd-signature tsd-kind-icon">private<wbr>Key<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
280
283
  <aside class="tsd-sources">
281
284
  <ul>
282
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1782">types.ts:1782</a></li>
285
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1845">datatypes.ts:1845</a></li>
283
286
  </ul>
284
287
  </aside>
285
288
  <div class="tsd-comment tsd-typography">
@@ -289,12 +292,12 @@
289
292
  </div>
290
293
  </section>
291
294
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
292
- <a name="serial_number" class="tsd-anchor"></a>
293
- <h3>serial_<wbr>number</h3>
294
- <div class="tsd-signature tsd-kind-icon">serial_<wbr>number<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
295
+ <a name="serialNumber" class="tsd-anchor"></a>
296
+ <h3>serial<wbr>Number</h3>
297
+ <div class="tsd-signature tsd-kind-icon">serial<wbr>Number<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
295
298
  <aside class="tsd-sources">
296
299
  <ul>
297
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1786">types.ts:1786</a></li>
300
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1849">datatypes.ts:1849</a></li>
298
301
  </ul>
299
302
  </aside>
300
303
  <div class="tsd-comment tsd-typography">
@@ -304,12 +307,12 @@
304
307
  </div>
305
308
  </section>
306
309
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
307
- <a name="subject_alternative_names" class="tsd-anchor"></a>
308
- <h3>subject_<wbr>alternative_<wbr>names</h3>
309
- <div class="tsd-signature tsd-kind-icon">subject_<wbr>alternative_<wbr>names<span class="tsd-signature-symbol">:</span> <a href="tlscertificatesans.html" class="tsd-signature-type" data-tsd-kind="Interface">TLSCertificateSANs</a></div>
310
+ <a name="subjectAlternativeNames" class="tsd-anchor"></a>
311
+ <h3>subject<wbr>Alternative<wbr>Names</h3>
312
+ <div class="tsd-signature tsd-kind-icon">subject<wbr>Alternative<wbr>Names<span class="tsd-signature-symbol">:</span> <a href="datatypes.TLSCertificateSANs.html" class="tsd-signature-type" data-tsd-kind="Interface">TLSCertificateSANs</a></div>
310
313
  <aside class="tsd-sources">
311
314
  <ul>
312
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1770">types.ts:1770</a></li>
315
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1833">datatypes.ts:1833</a></li>
313
316
  </ul>
314
317
  </aside>
315
318
  <div class="tsd-comment tsd-typography">
@@ -319,12 +322,12 @@
319
322
  </div>
320
323
  </section>
321
324
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
322
- <a name="subject_common_name" class="tsd-anchor"></a>
323
- <h3>subject_<wbr>common_<wbr>name</h3>
324
- <div class="tsd-signature tsd-kind-icon">subject_<wbr>common_<wbr>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
325
+ <a name="subjectCommonName" class="tsd-anchor"></a>
326
+ <h3>subject<wbr>Common<wbr>Name</h3>
327
+ <div class="tsd-signature tsd-kind-icon">subject<wbr>Common<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
325
328
  <aside class="tsd-sources">
326
329
  <ul>
327
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1768">types.ts:1768</a></li>
330
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1831">datatypes.ts:1831</a></li>
328
331
  </ul>
329
332
  </aside>
330
333
  <div class="tsd-comment tsd-typography">
@@ -334,12 +337,12 @@
334
337
  </div>
335
338
  </section>
336
339
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
337
- <a name="subject_country" class="tsd-anchor"></a>
338
- <h3>subject_<wbr>country</h3>
339
- <div class="tsd-signature tsd-kind-icon">subject_<wbr>country<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
340
+ <a name="subjectCountry" class="tsd-anchor"></a>
341
+ <h3>subject<wbr>Country</h3>
342
+ <div class="tsd-signature tsd-kind-icon">subject<wbr>Country<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
340
343
  <aside class="tsd-sources">
341
344
  <ul>
342
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1796">types.ts:1796</a></li>
345
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1859">datatypes.ts:1859</a></li>
343
346
  </ul>
344
347
  </aside>
345
348
  <div class="tsd-comment tsd-typography">
@@ -349,12 +352,12 @@
349
352
  </div>
350
353
  </section>
351
354
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
352
- <a name="subject_locality" class="tsd-anchor"></a>
353
- <h3>subject_<wbr>locality</h3>
354
- <div class="tsd-signature tsd-kind-icon">subject_<wbr>locality<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
355
+ <a name="subjectLocality" class="tsd-anchor"></a>
356
+ <h3>subject<wbr>Locality</h3>
357
+ <div class="tsd-signature tsd-kind-icon">subject<wbr>Locality<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
355
358
  <aside class="tsd-sources">
356
359
  <ul>
357
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1792">types.ts:1792</a></li>
360
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1855">datatypes.ts:1855</a></li>
358
361
  </ul>
359
362
  </aside>
360
363
  <div class="tsd-comment tsd-typography">
@@ -364,12 +367,12 @@
364
367
  </div>
365
368
  </section>
366
369
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
367
- <a name="subject_organization" class="tsd-anchor"></a>
368
- <h3>subject_<wbr>organization</h3>
369
- <div class="tsd-signature tsd-kind-icon">subject_<wbr>organization<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
370
+ <a name="subjectOrganization" class="tsd-anchor"></a>
371
+ <h3>subject<wbr>Organization</h3>
372
+ <div class="tsd-signature tsd-kind-icon">subject<wbr>Organization<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
370
373
  <aside class="tsd-sources">
371
374
  <ul>
372
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1788">types.ts:1788</a></li>
375
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1851">datatypes.ts:1851</a></li>
373
376
  </ul>
374
377
  </aside>
375
378
  <div class="tsd-comment tsd-typography">
@@ -379,12 +382,12 @@
379
382
  </div>
380
383
  </section>
381
384
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
382
- <a name="subject_organizational_unit" class="tsd-anchor"></a>
383
- <h3>subject_<wbr>organizational_<wbr>unit</h3>
384
- <div class="tsd-signature tsd-kind-icon">subject_<wbr>organizational_<wbr>unit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
385
+ <a name="subjectOrganizationalUnit" class="tsd-anchor"></a>
386
+ <h3>subject<wbr>Organizational<wbr>Unit</h3>
387
+ <div class="tsd-signature tsd-kind-icon">subject<wbr>Organizational<wbr>Unit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
385
388
  <aside class="tsd-sources">
386
389
  <ul>
387
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1790">types.ts:1790</a></li>
390
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1853">datatypes.ts:1853</a></li>
388
391
  </ul>
389
392
  </aside>
390
393
  <div class="tsd-comment tsd-typography">
@@ -394,12 +397,12 @@
394
397
  </div>
395
398
  </section>
396
399
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
397
- <a name="subject_province" class="tsd-anchor"></a>
398
- <h3>subject_<wbr>province</h3>
399
- <div class="tsd-signature tsd-kind-icon">subject_<wbr>province<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
400
+ <a name="subjectProvince" class="tsd-anchor"></a>
401
+ <h3>subject<wbr>Province</h3>
402
+ <div class="tsd-signature tsd-kind-icon">subject<wbr>Province<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
400
403
  <aside class="tsd-sources">
401
404
  <ul>
402
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1794">types.ts:1794</a></li>
405
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1857">datatypes.ts:1857</a></li>
403
406
  </ul>
404
407
  </aside>
405
408
  <div class="tsd-comment tsd-typography">
@@ -414,7 +417,7 @@
414
417
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
415
418
  <aside class="tsd-sources">
416
419
  <ul>
417
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1758">types.ts:1758</a></li>
420
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1821">datatypes.ts:1821</a></li>
418
421
  </ul>
419
422
  </aside>
420
423
  <div class="tsd-comment tsd-typography">
@@ -429,7 +432,16 @@
429
432
  <nav class="tsd-navigation primary">
430
433
  <ul>
431
434
  <li class=" ">
432
- <a href="../modules.html">Exports</a>
435
+ <a href="../modules.html">Modules</a>
436
+ </li>
437
+ <li class=" tsd-kind-module">
438
+ <a href="../modules/client.html">client</a>
439
+ </li>
440
+ <li class="current tsd-kind-module">
441
+ <a href="../modules/datatypes.html">datatypes</a>
442
+ </li>
443
+ <li class=" tsd-kind-module">
444
+ <a href="../modules/services.html">services</a>
433
445
  </li>
434
446
  </ul>
435
447
  </nav>
@@ -437,71 +449,71 @@
437
449
  <ul class="before-current">
438
450
  </ul>
439
451
  <ul class="current">
440
- <li class="current tsd-kind-interface">
441
- <a href="tlscertificate.html" class="tsd-kind-icon">TLSCertificate</a>
452
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
453
+ <a href="datatypes.TLSCertificate.html" class="tsd-kind-icon">TLSCertificate</a>
442
454
  <ul>
443
455
  <li class=" tsd-kind-property tsd-parent-kind-interface">
444
- <a href="tlscertificate.html#certificate_pem" class="tsd-kind-icon">certificate_<wbr>pem</a>
456
+ <a href="datatypes.TLSCertificate.html#certificatePem" class="tsd-kind-icon">certificate<wbr>Pem</a>
445
457
  </li>
446
458
  <li class=" tsd-kind-property tsd-parent-kind-interface">
447
- <a href="tlscertificate.html#created_at" class="tsd-kind-icon">created_<wbr>at</a>
459
+ <a href="datatypes.TLSCertificate.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
448
460
  </li>
449
461
  <li class=" tsd-kind-property tsd-parent-kind-interface">
450
- <a href="tlscertificate.html#description" class="tsd-kind-icon">description</a>
462
+ <a href="datatypes.TLSCertificate.html#description" class="tsd-kind-icon">description</a>
451
463
  </li>
452
464
  <li class=" tsd-kind-property tsd-parent-kind-interface">
453
- <a href="tlscertificate.html#extended_key_usages" class="tsd-kind-icon">extended_<wbr>key_<wbr>usages</a>
465
+ <a href="datatypes.TLSCertificate.html#extendedKeyUsages" class="tsd-kind-icon">extended<wbr>Key<wbr>Usages</a>
454
466
  </li>
455
467
  <li class=" tsd-kind-property tsd-parent-kind-interface">
456
- <a href="tlscertificate.html#id" class="tsd-kind-icon">id</a>
468
+ <a href="datatypes.TLSCertificate.html#id" class="tsd-kind-icon">id</a>
457
469
  </li>
458
470
  <li class=" tsd-kind-property tsd-parent-kind-interface">
459
- <a href="tlscertificate.html#issued_at" class="tsd-kind-icon">issued_<wbr>at</a>
471
+ <a href="datatypes.TLSCertificate.html#issuedAt" class="tsd-kind-icon">issued<wbr>At</a>
460
472
  </li>
461
473
  <li class=" tsd-kind-property tsd-parent-kind-interface">
462
- <a href="tlscertificate.html#issuer_common_name" class="tsd-kind-icon">issuer_<wbr>common_<wbr>name</a>
474
+ <a href="datatypes.TLSCertificate.html#issuerCommonName" class="tsd-kind-icon">issuer<wbr>Common<wbr>Name</a>
463
475
  </li>
464
476
  <li class=" tsd-kind-property tsd-parent-kind-interface">
465
- <a href="tlscertificate.html#key_usages" class="tsd-kind-icon">key_<wbr>usages</a>
477
+ <a href="datatypes.TLSCertificate.html#keyUsages" class="tsd-kind-icon">key<wbr>Usages</a>
466
478
  </li>
467
479
  <li class=" tsd-kind-property tsd-parent-kind-interface">
468
- <a href="tlscertificate.html#metadata" class="tsd-kind-icon">metadata</a>
480
+ <a href="datatypes.TLSCertificate.html#metadata" class="tsd-kind-icon">metadata</a>
469
481
  </li>
470
482
  <li class=" tsd-kind-property tsd-parent-kind-interface">
471
- <a href="tlscertificate.html#not_after" class="tsd-kind-icon">not_<wbr>after</a>
483
+ <a href="datatypes.TLSCertificate.html#notAfter" class="tsd-kind-icon">not<wbr>After</a>
472
484
  </li>
473
485
  <li class=" tsd-kind-property tsd-parent-kind-interface">
474
- <a href="tlscertificate.html#not_before" class="tsd-kind-icon">not_<wbr>before</a>
486
+ <a href="datatypes.TLSCertificate.html#notBefore" class="tsd-kind-icon">not<wbr>Before</a>
475
487
  </li>
476
488
  <li class=" tsd-kind-property tsd-parent-kind-interface">
477
- <a href="tlscertificate.html#private_key_type" class="tsd-kind-icon">private_<wbr>key_<wbr>type</a>
489
+ <a href="datatypes.TLSCertificate.html#privateKeyType" class="tsd-kind-icon">private<wbr>Key<wbr>Type</a>
478
490
  </li>
479
491
  <li class=" tsd-kind-property tsd-parent-kind-interface">
480
- <a href="tlscertificate.html#serial_number" class="tsd-kind-icon">serial_<wbr>number</a>
492
+ <a href="datatypes.TLSCertificate.html#serialNumber" class="tsd-kind-icon">serial<wbr>Number</a>
481
493
  </li>
482
494
  <li class=" tsd-kind-property tsd-parent-kind-interface">
483
- <a href="tlscertificate.html#subject_alternative_names" class="tsd-kind-icon">subject_<wbr>alternative_<wbr>names</a>
495
+ <a href="datatypes.TLSCertificate.html#subjectAlternativeNames" class="tsd-kind-icon">subject<wbr>Alternative<wbr>Names</a>
484
496
  </li>
485
497
  <li class=" tsd-kind-property tsd-parent-kind-interface">
486
- <a href="tlscertificate.html#subject_common_name" class="tsd-kind-icon">subject_<wbr>common_<wbr>name</a>
498
+ <a href="datatypes.TLSCertificate.html#subjectCommonName" class="tsd-kind-icon">subject<wbr>Common<wbr>Name</a>
487
499
  </li>
488
500
  <li class=" tsd-kind-property tsd-parent-kind-interface">
489
- <a href="tlscertificate.html#subject_country" class="tsd-kind-icon">subject_<wbr>country</a>
501
+ <a href="datatypes.TLSCertificate.html#subjectCountry" class="tsd-kind-icon">subject<wbr>Country</a>
490
502
  </li>
491
503
  <li class=" tsd-kind-property tsd-parent-kind-interface">
492
- <a href="tlscertificate.html#subject_locality" class="tsd-kind-icon">subject_<wbr>locality</a>
504
+ <a href="datatypes.TLSCertificate.html#subjectLocality" class="tsd-kind-icon">subject<wbr>Locality</a>
493
505
  </li>
494
506
  <li class=" tsd-kind-property tsd-parent-kind-interface">
495
- <a href="tlscertificate.html#subject_organization" class="tsd-kind-icon">subject_<wbr>organization</a>
507
+ <a href="datatypes.TLSCertificate.html#subjectOrganization" class="tsd-kind-icon">subject<wbr>Organization</a>
496
508
  </li>
497
509
  <li class=" tsd-kind-property tsd-parent-kind-interface">
498
- <a href="tlscertificate.html#subject_organizational_unit" class="tsd-kind-icon">subject_<wbr>organizational_<wbr>unit</a>
510
+ <a href="datatypes.TLSCertificate.html#subjectOrganizationalUnit" class="tsd-kind-icon">subject<wbr>Organizational<wbr>Unit</a>
499
511
  </li>
500
512
  <li class=" tsd-kind-property tsd-parent-kind-interface">
501
- <a href="tlscertificate.html#subject_province" class="tsd-kind-icon">subject_<wbr>province</a>
513
+ <a href="datatypes.TLSCertificate.html#subjectProvince" class="tsd-kind-icon">subject<wbr>Province</a>
502
514
  </li>
503
515
  <li class=" tsd-kind-property tsd-parent-kind-interface">
504
- <a href="tlscertificate.html#uri" class="tsd-kind-icon">uri</a>
516
+ <a href="datatypes.TLSCertificate.html#uri" class="tsd-kind-icon">uri</a>
505
517
  </li>
506
518
  </ul>
507
519
  </li>
@@ -517,11 +529,11 @@
517
529
  <h2>Legend</h2>
518
530
  <div class="tsd-legend-group">
519
531
  <ul class="tsd-legend">
520
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
521
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
532
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
533
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
522
534
  </ul>
523
535
  <ul class="tsd-legend">
524
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
536
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
525
537
  </ul>
526
538
  </div>
527
539
  </div>