@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/{sshhostcertificate.html → datatypes.SSHHostCertificate.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="sshhostcertificate.html">SSHHostCertificate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.SSHHostCertificate.html">SSHHostCertificate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface SSHHostCertificate</h1>
@@ -80,18 +83,18 @@
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="sshhostcertificate.html#certificate" class="tsd-kind-icon">certificate</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificate.html#created_at" class="tsd-kind-icon">created_<wbr>at</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificate.html#description" class="tsd-kind-icon">description</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificate.html#id" class="tsd-kind-icon">id</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificate.html#key_type" class="tsd-kind-icon">key_<wbr>type</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificate.html#metadata" class="tsd-kind-icon">metadata</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificate.html#principals" class="tsd-kind-icon">principals</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificate.html#public_key" class="tsd-kind-icon">public_<wbr>key</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificate.html#ssh_certificate_authority_id" class="tsd-kind-icon">ssh_<wbr>certificate_<wbr>authority_<wbr>id</a></li>
92
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificate.html#uri" class="tsd-kind-icon">uri</a></li>
93
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificate.html#valid_after" class="tsd-kind-icon">valid_<wbr>after</a></li>
94
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificate.html#valid_until" class="tsd-kind-icon">valid_<wbr>until</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#certificate" class="tsd-kind-icon">certificate</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#description" class="tsd-kind-icon">description</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#id" class="tsd-kind-icon">id</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#keyType" class="tsd-kind-icon">key<wbr>Type</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#metadata" class="tsd-kind-icon">metadata</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#principals" class="tsd-kind-icon">principals</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#sshCertificateAuthorityId" class="tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#uri" class="tsd-kind-icon">uri</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#validAfter" class="tsd-kind-icon">valid<wbr>After</a></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#validUntil" class="tsd-kind-icon">valid<wbr>Until</a></li>
95
98
  </ul>
96
99
  </section>
97
100
  </div>
@@ -105,22 +108,22 @@
105
108
  <div class="tsd-signature tsd-kind-icon">certificate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
106
109
  <aside class="tsd-sources">
107
110
  <ul>
108
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1654">types.ts:1654</a></li>
111
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1717">datatypes.ts:1717</a></li>
109
112
  </ul>
110
113
  </aside>
111
114
  <div class="tsd-comment tsd-typography">
112
115
  <div class="lead">
113
- <p>the signed SSH certificate in OpenSSH Authorized Keys format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive</p>
116
+ <p>the signed SSH certificate in OpenSSH Authorized Keys format. this value should be placed in a <code>-cert.pub</code> certificate file on disk that should be referenced in your <code>sshd_config</code> configuration file with a <code>HostCertificate</code> directive</p>
114
117
  </div>
115
118
  </div>
116
119
  </section>
117
120
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
118
- <a name="created_at" class="tsd-anchor"></a>
119
- <h3>created_<wbr>at</h3>
120
- <div class="tsd-signature tsd-kind-icon">created_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
121
+ <a name="createdAt" class="tsd-anchor"></a>
122
+ <h3>created<wbr>At</h3>
123
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
121
124
  <aside class="tsd-sources">
122
125
  <ul>
123
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1636">types.ts:1636</a></li>
126
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1699">datatypes.ts:1699</a></li>
124
127
  </ul>
125
128
  </aside>
126
129
  <div class="tsd-comment tsd-typography">
@@ -135,7 +138,7 @@
135
138
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
136
139
  <aside class="tsd-sources">
137
140
  <ul>
138
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1638">types.ts:1638</a></li>
141
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1701">datatypes.ts:1701</a></li>
139
142
  </ul>
140
143
  </aside>
141
144
  <div class="tsd-comment tsd-typography">
@@ -150,7 +153,7 @@
150
153
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
151
154
  <aside class="tsd-sources">
152
155
  <ul>
153
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1632">types.ts:1632</a></li>
156
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1695">datatypes.ts:1695</a></li>
154
157
  </ul>
155
158
  </aside>
156
159
  <div class="tsd-comment tsd-typography">
@@ -160,17 +163,17 @@
160
163
  </div>
161
164
  </section>
162
165
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
163
- <a name="key_type" class="tsd-anchor"></a>
164
- <h3>key_<wbr>type</h3>
165
- <div class="tsd-signature tsd-kind-icon">key_<wbr>type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
166
+ <a name="keyType" class="tsd-anchor"></a>
167
+ <h3>key<wbr>Type</h3>
168
+ <div class="tsd-signature tsd-kind-icon">key<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
166
169
  <aside class="tsd-sources">
167
170
  <ul>
168
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1644">types.ts:1644</a></li>
171
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1707">datatypes.ts:1707</a></li>
169
172
  </ul>
170
173
  </aside>
171
174
  <div class="tsd-comment tsd-typography">
172
175
  <div class="lead">
173
- <p>the key type of the public_key, one of rsa, ecdsa or ed25519</p>
176
+ <p>the key type of the <code>public_key</code>, one of <code>rsa</code>, <code>ecdsa</code> or <code>ed25519</code></p>
174
177
  </div>
175
178
  </div>
176
179
  </section>
@@ -180,7 +183,7 @@
180
183
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
181
184
  <aside class="tsd-sources">
182
185
  <ul>
183
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1640">types.ts:1640</a></li>
186
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1703">datatypes.ts:1703</a></li>
184
187
  </ul>
185
188
  </aside>
186
189
  <div class="tsd-comment tsd-typography">
@@ -195,7 +198,7 @@
195
198
  <div class="tsd-signature tsd-kind-icon">principals<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
196
199
  <aside class="tsd-sources">
197
200
  <ul>
198
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1648">types.ts:1648</a></li>
201
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1711">datatypes.ts:1711</a></li>
199
202
  </ul>
200
203
  </aside>
201
204
  <div class="tsd-comment tsd-typography">
@@ -205,12 +208,12 @@
205
208
  </div>
206
209
  </section>
207
210
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
208
- <a name="public_key" class="tsd-anchor"></a>
209
- <h3>public_<wbr>key</h3>
210
- <div class="tsd-signature tsd-kind-icon">public_<wbr>key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
211
+ <a name="publicKey" class="tsd-anchor"></a>
212
+ <h3>public<wbr>Key</h3>
213
+ <div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
211
214
  <aside class="tsd-sources">
212
215
  <ul>
213
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1642">types.ts:1642</a></li>
216
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1705">datatypes.ts:1705</a></li>
214
217
  </ul>
215
218
  </aside>
216
219
  <div class="tsd-comment tsd-typography">
@@ -220,12 +223,12 @@
220
223
  </div>
221
224
  </section>
222
225
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
223
- <a name="ssh_certificate_authority_id" class="tsd-anchor"></a>
224
- <h3>ssh_<wbr>certificate_<wbr>authority_<wbr>id</h3>
225
- <div class="tsd-signature tsd-kind-icon">ssh_<wbr>certificate_<wbr>authority_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
226
+ <a name="sshCertificateAuthorityId" class="tsd-anchor"></a>
227
+ <h3>ssh<wbr>Certificate<wbr>Authority<wbr>Id</h3>
228
+ <div class="tsd-signature tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
226
229
  <aside class="tsd-sources">
227
230
  <ul>
228
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1646">types.ts:1646</a></li>
231
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1709">datatypes.ts:1709</a></li>
229
232
  </ul>
230
233
  </aside>
231
234
  <div class="tsd-comment tsd-typography">
@@ -240,7 +243,7 @@
240
243
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
241
244
  <aside class="tsd-sources">
242
245
  <ul>
243
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1634">types.ts:1634</a></li>
246
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1697">datatypes.ts:1697</a></li>
244
247
  </ul>
245
248
  </aside>
246
249
  <div class="tsd-comment tsd-typography">
@@ -250,12 +253,12 @@
250
253
  </div>
251
254
  </section>
252
255
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
253
- <a name="valid_after" class="tsd-anchor"></a>
254
- <h3>valid_<wbr>after</h3>
255
- <div class="tsd-signature tsd-kind-icon">valid_<wbr>after<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
256
+ <a name="validAfter" class="tsd-anchor"></a>
257
+ <h3>valid<wbr>After</h3>
258
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
256
259
  <aside class="tsd-sources">
257
260
  <ul>
258
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1650">types.ts:1650</a></li>
261
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1713">datatypes.ts:1713</a></li>
259
262
  </ul>
260
263
  </aside>
261
264
  <div class="tsd-comment tsd-typography">
@@ -265,17 +268,17 @@
265
268
  </div>
266
269
  </section>
267
270
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
268
- <a name="valid_until" class="tsd-anchor"></a>
269
- <h3>valid_<wbr>until</h3>
270
- <div class="tsd-signature tsd-kind-icon">valid_<wbr>until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
271
+ <a name="validUntil" class="tsd-anchor"></a>
272
+ <h3>valid<wbr>Until</h3>
273
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>Until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
271
274
  <aside class="tsd-sources">
272
275
  <ul>
273
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1652">types.ts:1652</a></li>
276
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1715">datatypes.ts:1715</a></li>
274
277
  </ul>
275
278
  </aside>
276
279
  <div class="tsd-comment tsd-typography">
277
280
  <div class="lead">
278
- <p>the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.</p>
281
+ <p>the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this <code>valid_before</code>.</p>
279
282
  </div>
280
283
  </div>
281
284
  </section>
@@ -285,7 +288,16 @@
285
288
  <nav class="tsd-navigation primary">
286
289
  <ul>
287
290
  <li class=" ">
288
- <a href="../modules.html">Exports</a>
291
+ <a href="../modules.html">Modules</a>
292
+ </li>
293
+ <li class=" tsd-kind-module">
294
+ <a href="../modules/client.html">client</a>
295
+ </li>
296
+ <li class="current tsd-kind-module">
297
+ <a href="../modules/datatypes.html">datatypes</a>
298
+ </li>
299
+ <li class=" tsd-kind-module">
300
+ <a href="../modules/services.html">services</a>
289
301
  </li>
290
302
  </ul>
291
303
  </nav>
@@ -293,44 +305,44 @@
293
305
  <ul class="before-current">
294
306
  </ul>
295
307
  <ul class="current">
296
- <li class="current tsd-kind-interface">
297
- <a href="sshhostcertificate.html" class="tsd-kind-icon">SSHHost<wbr>Certificate</a>
308
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
309
+ <a href="datatypes.SSHHostCertificate.html" class="tsd-kind-icon">SSHHost<wbr>Certificate</a>
298
310
  <ul>
299
311
  <li class=" tsd-kind-property tsd-parent-kind-interface">
300
- <a href="sshhostcertificate.html#certificate" class="tsd-kind-icon">certificate</a>
312
+ <a href="datatypes.SSHHostCertificate.html#certificate" class="tsd-kind-icon">certificate</a>
301
313
  </li>
302
314
  <li class=" tsd-kind-property tsd-parent-kind-interface">
303
- <a href="sshhostcertificate.html#created_at" class="tsd-kind-icon">created_<wbr>at</a>
315
+ <a href="datatypes.SSHHostCertificate.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
304
316
  </li>
305
317
  <li class=" tsd-kind-property tsd-parent-kind-interface">
306
- <a href="sshhostcertificate.html#description" class="tsd-kind-icon">description</a>
318
+ <a href="datatypes.SSHHostCertificate.html#description" class="tsd-kind-icon">description</a>
307
319
  </li>
308
320
  <li class=" tsd-kind-property tsd-parent-kind-interface">
309
- <a href="sshhostcertificate.html#id" class="tsd-kind-icon">id</a>
321
+ <a href="datatypes.SSHHostCertificate.html#id" class="tsd-kind-icon">id</a>
310
322
  </li>
311
323
  <li class=" tsd-kind-property tsd-parent-kind-interface">
312
- <a href="sshhostcertificate.html#key_type" class="tsd-kind-icon">key_<wbr>type</a>
324
+ <a href="datatypes.SSHHostCertificate.html#keyType" class="tsd-kind-icon">key<wbr>Type</a>
313
325
  </li>
314
326
  <li class=" tsd-kind-property tsd-parent-kind-interface">
315
- <a href="sshhostcertificate.html#metadata" class="tsd-kind-icon">metadata</a>
327
+ <a href="datatypes.SSHHostCertificate.html#metadata" class="tsd-kind-icon">metadata</a>
316
328
  </li>
317
329
  <li class=" tsd-kind-property tsd-parent-kind-interface">
318
- <a href="sshhostcertificate.html#principals" class="tsd-kind-icon">principals</a>
330
+ <a href="datatypes.SSHHostCertificate.html#principals" class="tsd-kind-icon">principals</a>
319
331
  </li>
320
332
  <li class=" tsd-kind-property tsd-parent-kind-interface">
321
- <a href="sshhostcertificate.html#public_key" class="tsd-kind-icon">public_<wbr>key</a>
333
+ <a href="datatypes.SSHHostCertificate.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a>
322
334
  </li>
323
335
  <li class=" tsd-kind-property tsd-parent-kind-interface">
324
- <a href="sshhostcertificate.html#ssh_certificate_authority_id" class="tsd-kind-icon">ssh_<wbr>certificate_<wbr>authority_<wbr>id</a>
336
+ <a href="datatypes.SSHHostCertificate.html#sshCertificateAuthorityId" class="tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id</a>
325
337
  </li>
326
338
  <li class=" tsd-kind-property tsd-parent-kind-interface">
327
- <a href="sshhostcertificate.html#uri" class="tsd-kind-icon">uri</a>
339
+ <a href="datatypes.SSHHostCertificate.html#uri" class="tsd-kind-icon">uri</a>
328
340
  </li>
329
341
  <li class=" tsd-kind-property tsd-parent-kind-interface">
330
- <a href="sshhostcertificate.html#valid_after" class="tsd-kind-icon">valid_<wbr>after</a>
342
+ <a href="datatypes.SSHHostCertificate.html#validAfter" class="tsd-kind-icon">valid<wbr>After</a>
331
343
  </li>
332
344
  <li class=" tsd-kind-property tsd-parent-kind-interface">
333
- <a href="sshhostcertificate.html#valid_until" class="tsd-kind-icon">valid_<wbr>until</a>
345
+ <a href="datatypes.SSHHostCertificate.html#validUntil" class="tsd-kind-icon">valid<wbr>Until</a>
334
346
  </li>
335
347
  </ul>
336
348
  </li>
@@ -346,11 +358,11 @@
346
358
  <h2>Legend</h2>
347
359
  <div class="tsd-legend-group">
348
360
  <ul class="tsd-legend">
349
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
350
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
361
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
362
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
351
363
  </ul>
352
364
  <ul class="tsd-legend">
353
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
365
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
354
366
  </ul>
355
367
  </div>
356
368
  </div>
package/docs/interfaces/{sshhostcertificatecreate.html → datatypes.SSHHostCertificateCreate.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="sshhostcertificatecreate.html">SSHHostCertificateCreate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.SSHHostCertificateCreate.html">SSHHostCertificateCreate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface SSHHostCertificateCreate</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="sshhostcertificatecreate.html#description" class="tsd-kind-icon">description</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificatecreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificatecreate.html#principals" class="tsd-kind-icon">principals</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificatecreate.html#public_key" class="tsd-kind-icon">public_<wbr>key</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificatecreate.html#ssh_certificate_authority_id" class="tsd-kind-icon">ssh_<wbr>certificate_<wbr>authority_<wbr>id</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificatecreate.html#valid_after" class="tsd-kind-icon">valid_<wbr>after</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshhostcertificatecreate.html#valid_until" class="tsd-kind-icon">valid_<wbr>until</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificateCreate.html#description" class="tsd-kind-icon">description</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificateCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificateCreate.html#principals" class="tsd-kind-icon">principals</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificateCreate.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificateCreate.html#sshCertificateAuthorityId" class="tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificateCreate.html#validAfter" class="tsd-kind-icon">valid<wbr>After</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificateCreate.html#validUntil" class="tsd-kind-icon">valid<wbr>Until</a></li>
90
93
  </ul>
91
94
  </section>
92
95
  </div>
@@ -100,7 +103,7 @@
100
103
  <div class="tsd-signature tsd-kind-icon">description<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#L1617">types.ts:1617</a></li>
106
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1680">datatypes.ts:1680</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">metadata<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#L1619">types.ts:1619</a></li>
121
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1682">datatypes.ts:1682</a></li>
119
122
  </ul>
120
123
  </aside>
121
124
  <div class="tsd-comment tsd-typography">
@@ -130,7 +133,7 @@
130
133
  <div class="tsd-signature tsd-kind-icon">principals<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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#L1611">types.ts:1611</a></li>
136
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1674">datatypes.ts:1674</a></li>
134
137
  </ul>
135
138
  </aside>
136
139
  <div class="tsd-comment tsd-typography">
@@ -140,12 +143,12 @@
140
143
  </div>
141
144
  </section>
142
145
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
143
- <a name="public_key" class="tsd-anchor"></a>
144
- <h3>public_<wbr>key</h3>
145
- <div class="tsd-signature tsd-kind-icon">public_<wbr>key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
146
+ <a name="publicKey" class="tsd-anchor"></a>
147
+ <h3>public<wbr>Key</h3>
148
+ <div class="tsd-signature tsd-kind-icon">public<wbr>Key<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#L1609">types.ts:1609</a></li>
151
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1672">datatypes.ts:1672</a></li>
149
152
  </ul>
150
153
  </aside>
151
154
  <div class="tsd-comment tsd-typography">
@@ -155,12 +158,12 @@
155
158
  </div>
156
159
  </section>
157
160
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
158
- <a name="ssh_certificate_authority_id" class="tsd-anchor"></a>
159
- <h3>ssh_<wbr>certificate_<wbr>authority_<wbr>id</h3>
160
- <div class="tsd-signature tsd-kind-icon">ssh_<wbr>certificate_<wbr>authority_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
161
+ <a name="sshCertificateAuthorityId" class="tsd-anchor"></a>
162
+ <h3>ssh<wbr>Certificate<wbr>Authority<wbr>Id</h3>
163
+ <div class="tsd-signature tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id<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#L1607">types.ts:1607</a></li>
166
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1670">datatypes.ts:1670</a></li>
164
167
  </ul>
165
168
  </aside>
166
169
  <div class="tsd-comment tsd-typography">
@@ -170,12 +173,12 @@
170
173
  </div>
171
174
  </section>
172
175
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
173
- <a name="valid_after" class="tsd-anchor"></a>
174
- <h3>valid_<wbr>after</h3>
175
- <div class="tsd-signature tsd-kind-icon">valid_<wbr>after<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
176
+ <a name="validAfter" class="tsd-anchor"></a>
177
+ <h3>valid<wbr>After</h3>
178
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></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#L1613">types.ts:1613</a></li>
181
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1676">datatypes.ts:1676</a></li>
179
182
  </ul>
180
183
  </aside>
181
184
  <div class="tsd-comment tsd-typography">
@@ -185,17 +188,17 @@
185
188
  </div>
186
189
  </section>
187
190
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
188
- <a name="valid_until" class="tsd-anchor"></a>
189
- <h3>valid_<wbr>until</h3>
190
- <div class="tsd-signature tsd-kind-icon">valid_<wbr>until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
191
+ <a name="validUntil" class="tsd-anchor"></a>
192
+ <h3>valid<wbr>Until</h3>
193
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>Until<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#L1615">types.ts:1615</a></li>
196
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1678">datatypes.ts:1678</a></li>
194
197
  </ul>
195
198
  </aside>
196
199
  <div class="tsd-comment tsd-typography">
197
200
  <div class="lead">
198
- <p>The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of one year in the future will be used. The OpenSSH certificates RFC calls this valid_before.</p>
201
+ <p>The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of one year in the future will be used. The OpenSSH certificates RFC calls this <code>valid_before</code>.</p>
199
202
  </div>
200
203
  </div>
201
204
  </section>
@@ -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="sshhostcertificatecreate.html" class="tsd-kind-icon">SSHHost<wbr>Certificate<wbr>Create</a>
228
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
229
+ <a href="datatypes.SSHHostCertificateCreate.html" class="tsd-kind-icon">SSHHost<wbr>Certificate<wbr>Create</a>
218
230
  <ul>
219
231
  <li class=" tsd-kind-property tsd-parent-kind-interface">
220
- <a href="sshhostcertificatecreate.html#description" class="tsd-kind-icon">description</a>
232
+ <a href="datatypes.SSHHostCertificateCreate.html#description" class="tsd-kind-icon">description</a>
221
233
  </li>
222
234
  <li class=" tsd-kind-property tsd-parent-kind-interface">
223
- <a href="sshhostcertificatecreate.html#metadata" class="tsd-kind-icon">metadata</a>
235
+ <a href="datatypes.SSHHostCertificateCreate.html#metadata" class="tsd-kind-icon">metadata</a>
224
236
  </li>
225
237
  <li class=" tsd-kind-property tsd-parent-kind-interface">
226
- <a href="sshhostcertificatecreate.html#principals" class="tsd-kind-icon">principals</a>
238
+ <a href="datatypes.SSHHostCertificateCreate.html#principals" class="tsd-kind-icon">principals</a>
227
239
  </li>
228
240
  <li class=" tsd-kind-property tsd-parent-kind-interface">
229
- <a href="sshhostcertificatecreate.html#public_key" class="tsd-kind-icon">public_<wbr>key</a>
241
+ <a href="datatypes.SSHHostCertificateCreate.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a>
230
242
  </li>
231
243
  <li class=" tsd-kind-property tsd-parent-kind-interface">
232
- <a href="sshhostcertificatecreate.html#ssh_certificate_authority_id" class="tsd-kind-icon">ssh_<wbr>certificate_<wbr>authority_<wbr>id</a>
244
+ <a href="datatypes.SSHHostCertificateCreate.html#sshCertificateAuthorityId" class="tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id</a>
233
245
  </li>
234
246
  <li class=" tsd-kind-property tsd-parent-kind-interface">
235
- <a href="sshhostcertificatecreate.html#valid_after" class="tsd-kind-icon">valid_<wbr>after</a>
247
+ <a href="datatypes.SSHHostCertificateCreate.html#validAfter" class="tsd-kind-icon">valid<wbr>After</a>
236
248
  </li>
237
249
  <li class=" tsd-kind-property tsd-parent-kind-interface">
238
- <a href="sshhostcertificatecreate.html#valid_until" class="tsd-kind-icon">valid_<wbr>until</a>
250
+ <a href="datatypes.SSHHostCertificateCreate.html#validUntil" class="tsd-kind-icon">valid<wbr>Until</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>