@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/{sshusercertificatecreate.html → datatypes.SSHUserCertificateCreate.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="sshusercertificatecreate.html">SSHUserCertificateCreate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.SSHUserCertificateCreate.html">SSHUserCertificateCreate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface SSHUserCertificateCreate</h1>
@@ -80,15 +83,15 @@
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="sshusercertificatecreate.html#critical_options" class="tsd-kind-icon">critical_<wbr>options</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshusercertificatecreate.html#description" class="tsd-kind-icon">description</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshusercertificatecreate.html#extensions" class="tsd-kind-icon">extensions</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshusercertificatecreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshusercertificatecreate.html#principals" class="tsd-kind-icon">principals</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshusercertificatecreate.html#public_key" class="tsd-kind-icon">public_<wbr>key</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshusercertificatecreate.html#ssh_certificate_authority_id" class="tsd-kind-icon">ssh_<wbr>certificate_<wbr>authority_<wbr>id</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshusercertificatecreate.html#valid_after" class="tsd-kind-icon">valid_<wbr>after</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshusercertificatecreate.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.SSHUserCertificateCreate.html#criticalOptions" class="tsd-kind-icon">critical<wbr>Options</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#extensions" class="tsd-kind-icon">extensions</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#principals" class="tsd-kind-icon">principals</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#sshCertificateAuthorityId" class="tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#validAfter" class="tsd-kind-icon">valid<wbr>After</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#validUntil" class="tsd-kind-icon">valid<wbr>Until</a></li>
92
95
  </ul>
93
96
  </section>
94
97
  </div>
@@ -97,17 +100,17 @@
97
100
  <section class="tsd-panel-group tsd-member-group ">
98
101
  <h2>Properties</h2>
99
102
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
100
- <a name="critical_options" class="tsd-anchor"></a>
101
- <h3>critical_<wbr>options</h3>
102
- <div class="tsd-signature tsd-kind-icon">critical_<wbr>options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
103
+ <a name="criticalOptions" class="tsd-anchor"></a>
104
+ <h3>critical<wbr>Options</h3>
105
+ <div class="tsd-signature tsd-kind-icon">critical<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
103
106
  <aside class="tsd-sources">
104
107
  <ul>
105
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1674">types.ts:1674</a></li>
108
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1737">datatypes.ts:1737</a></li>
106
109
  </ul>
107
110
  </aside>
108
111
  <div class="tsd-comment tsd-typography">
109
112
  <div class="lead">
110
- <p>A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See (<a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys)the">https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys)the</a> OpenSSH certificate protocol spec for additional details.</p>
113
+ <p>A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: <code>force-command</code> and <code>source-address</code>. See <a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys">the OpenSSH certificate protocol spec</a> for additional details.</p>
111
114
  </div>
112
115
  </div>
113
116
  </section>
@@ -117,7 +120,7 @@
117
120
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
118
121
  <aside class="tsd-sources">
119
122
  <ul>
120
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1682">types.ts:1682</a></li>
123
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1745">datatypes.ts:1745</a></li>
121
124
  </ul>
122
125
  </aside>
123
126
  <div class="tsd-comment tsd-typography">
@@ -132,12 +135,12 @@
132
135
  <div class="tsd-signature tsd-kind-icon">extensions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
133
136
  <aside class="tsd-sources">
134
137
  <ul>
135
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1676">types.ts:1676</a></li>
138
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1739">datatypes.ts:1739</a></li>
136
139
  </ul>
137
140
  </aside>
138
141
  <div class="tsd-comment tsd-typography">
139
142
  <div class="lead">
140
- <p>A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {&quot;permit-pty&quot;: &quot;&quot;, &quot;permit-user-rc&quot;: &quot;&quot;} OpenSSH understands a number of predefined extensions. See (<a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys)the">https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys)the</a> OpenSSH certificate protocol spec for additional details.</p>
143
+ <p>A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: <code>{&quot;permit-pty&quot;: &quot;&quot;, &quot;permit-user-rc&quot;: &quot;&quot;}</code> OpenSSH understands a number of predefined extensions. See <a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys">the OpenSSH certificate protocol spec</a> for additional details.</p>
141
144
  </div>
142
145
  </div>
143
146
  </section>
@@ -147,7 +150,7 @@
147
150
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
148
151
  <aside class="tsd-sources">
149
152
  <ul>
150
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1684">types.ts:1684</a></li>
153
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1747">datatypes.ts:1747</a></li>
151
154
  </ul>
152
155
  </aside>
153
156
  <div class="tsd-comment tsd-typography">
@@ -162,7 +165,7 @@
162
165
  <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>
163
166
  <aside class="tsd-sources">
164
167
  <ul>
165
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1672">types.ts:1672</a></li>
168
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1735">datatypes.ts:1735</a></li>
166
169
  </ul>
167
170
  </aside>
168
171
  <div class="tsd-comment tsd-typography">
@@ -172,12 +175,12 @@
172
175
  </div>
173
176
  </section>
174
177
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
175
- <a name="public_key" class="tsd-anchor"></a>
176
- <h3>public_<wbr>key</h3>
177
- <div class="tsd-signature tsd-kind-icon">public_<wbr>key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
178
+ <a name="publicKey" class="tsd-anchor"></a>
179
+ <h3>public<wbr>Key</h3>
180
+ <div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
178
181
  <aside class="tsd-sources">
179
182
  <ul>
180
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1670">types.ts:1670</a></li>
183
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1733">datatypes.ts:1733</a></li>
181
184
  </ul>
182
185
  </aside>
183
186
  <div class="tsd-comment tsd-typography">
@@ -187,12 +190,12 @@
187
190
  </div>
188
191
  </section>
189
192
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
190
- <a name="ssh_certificate_authority_id" class="tsd-anchor"></a>
191
- <h3>ssh_<wbr>certificate_<wbr>authority_<wbr>id</h3>
192
- <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>
193
+ <a name="sshCertificateAuthorityId" class="tsd-anchor"></a>
194
+ <h3>ssh<wbr>Certificate<wbr>Authority<wbr>Id</h3>
195
+ <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>
193
196
  <aside class="tsd-sources">
194
197
  <ul>
195
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1668">types.ts:1668</a></li>
198
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1731">datatypes.ts:1731</a></li>
196
199
  </ul>
197
200
  </aside>
198
201
  <div class="tsd-comment tsd-typography">
@@ -202,12 +205,12 @@
202
205
  </div>
203
206
  </section>
204
207
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
205
- <a name="valid_after" class="tsd-anchor"></a>
206
- <h3>valid_<wbr>after</h3>
207
- <div class="tsd-signature tsd-kind-icon">valid_<wbr>after<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
208
+ <a name="validAfter" class="tsd-anchor"></a>
209
+ <h3>valid<wbr>After</h3>
210
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
208
211
  <aside class="tsd-sources">
209
212
  <ul>
210
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1678">types.ts:1678</a></li>
213
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1741">datatypes.ts:1741</a></li>
211
214
  </ul>
212
215
  </aside>
213
216
  <div class="tsd-comment tsd-typography">
@@ -217,17 +220,17 @@
217
220
  </div>
218
221
  </section>
219
222
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
220
- <a name="valid_until" class="tsd-anchor"></a>
221
- <h3>valid_<wbr>until</h3>
222
- <div class="tsd-signature tsd-kind-icon">valid_<wbr>until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
223
+ <a name="validUntil" class="tsd-anchor"></a>
224
+ <h3>valid<wbr>Until</h3>
225
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>Until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
223
226
  <aside class="tsd-sources">
224
227
  <ul>
225
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1680">types.ts:1680</a></li>
228
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1743">datatypes.ts:1743</a></li>
226
229
  </ul>
227
230
  </aside>
228
231
  <div class="tsd-comment tsd-typography">
229
232
  <div class="lead">
230
- <p>The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this valid_before.</p>
233
+ <p>The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this <code>valid_before</code>.</p>
231
234
  </div>
232
235
  </div>
233
236
  </section>
@@ -237,7 +240,16 @@
237
240
  <nav class="tsd-navigation primary">
238
241
  <ul>
239
242
  <li class=" ">
240
- <a href="../modules.html">Exports</a>
243
+ <a href="../modules.html">Modules</a>
244
+ </li>
245
+ <li class=" tsd-kind-module">
246
+ <a href="../modules/client.html">client</a>
247
+ </li>
248
+ <li class="current tsd-kind-module">
249
+ <a href="../modules/datatypes.html">datatypes</a>
250
+ </li>
251
+ <li class=" tsd-kind-module">
252
+ <a href="../modules/services.html">services</a>
241
253
  </li>
242
254
  </ul>
243
255
  </nav>
@@ -245,35 +257,35 @@
245
257
  <ul class="before-current">
246
258
  </ul>
247
259
  <ul class="current">
248
- <li class="current tsd-kind-interface">
249
- <a href="sshusercertificatecreate.html" class="tsd-kind-icon">SSHUser<wbr>Certificate<wbr>Create</a>
260
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
261
+ <a href="datatypes.SSHUserCertificateCreate.html" class="tsd-kind-icon">SSHUser<wbr>Certificate<wbr>Create</a>
250
262
  <ul>
251
263
  <li class=" tsd-kind-property tsd-parent-kind-interface">
252
- <a href="sshusercertificatecreate.html#critical_options" class="tsd-kind-icon">critical_<wbr>options</a>
264
+ <a href="datatypes.SSHUserCertificateCreate.html#criticalOptions" class="tsd-kind-icon">critical<wbr>Options</a>
253
265
  </li>
254
266
  <li class=" tsd-kind-property tsd-parent-kind-interface">
255
- <a href="sshusercertificatecreate.html#description" class="tsd-kind-icon">description</a>
267
+ <a href="datatypes.SSHUserCertificateCreate.html#description" class="tsd-kind-icon">description</a>
256
268
  </li>
257
269
  <li class=" tsd-kind-property tsd-parent-kind-interface">
258
- <a href="sshusercertificatecreate.html#extensions" class="tsd-kind-icon">extensions</a>
270
+ <a href="datatypes.SSHUserCertificateCreate.html#extensions" class="tsd-kind-icon">extensions</a>
259
271
  </li>
260
272
  <li class=" tsd-kind-property tsd-parent-kind-interface">
261
- <a href="sshusercertificatecreate.html#metadata" class="tsd-kind-icon">metadata</a>
273
+ <a href="datatypes.SSHUserCertificateCreate.html#metadata" class="tsd-kind-icon">metadata</a>
262
274
  </li>
263
275
  <li class=" tsd-kind-property tsd-parent-kind-interface">
264
- <a href="sshusercertificatecreate.html#principals" class="tsd-kind-icon">principals</a>
276
+ <a href="datatypes.SSHUserCertificateCreate.html#principals" class="tsd-kind-icon">principals</a>
265
277
  </li>
266
278
  <li class=" tsd-kind-property tsd-parent-kind-interface">
267
- <a href="sshusercertificatecreate.html#public_key" class="tsd-kind-icon">public_<wbr>key</a>
279
+ <a href="datatypes.SSHUserCertificateCreate.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a>
268
280
  </li>
269
281
  <li class=" tsd-kind-property tsd-parent-kind-interface">
270
- <a href="sshusercertificatecreate.html#ssh_certificate_authority_id" class="tsd-kind-icon">ssh_<wbr>certificate_<wbr>authority_<wbr>id</a>
282
+ <a href="datatypes.SSHUserCertificateCreate.html#sshCertificateAuthorityId" class="tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id</a>
271
283
  </li>
272
284
  <li class=" tsd-kind-property tsd-parent-kind-interface">
273
- <a href="sshusercertificatecreate.html#valid_after" class="tsd-kind-icon">valid_<wbr>after</a>
285
+ <a href="datatypes.SSHUserCertificateCreate.html#validAfter" class="tsd-kind-icon">valid<wbr>After</a>
274
286
  </li>
275
287
  <li class=" tsd-kind-property tsd-parent-kind-interface">
276
- <a href="sshusercertificatecreate.html#valid_until" class="tsd-kind-icon">valid_<wbr>until</a>
288
+ <a href="datatypes.SSHUserCertificateCreate.html#validUntil" class="tsd-kind-icon">valid<wbr>Until</a>
277
289
  </li>
278
290
  </ul>
279
291
  </li>
@@ -289,11 +301,11 @@
289
301
  <h2>Legend</h2>
290
302
  <div class="tsd-legend-group">
291
303
  <ul class="tsd-legend">
292
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
293
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
304
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
305
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
294
306
  </ul>
295
307
  <ul class="tsd-legend">
296
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
308
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
297
309
  </ul>
298
310
  </div>
299
311
  </div>
package/docs/interfaces/{sshusercertificatelist.html → datatypes.SSHUserCertificateList.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="sshusercertificatelist.html">SSHUserCertificateList</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.SSHUserCertificateList.html">SSHUserCertificateList</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface SSHUserCertificateList</h1>
@@ -80,9 +83,9 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshusercertificatelist.html#next_page_uri" class="tsd-kind-icon">next_<wbr>page_<wbr>uri</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshusercertificatelist.html#ssh_user_certificates" class="tsd-kind-icon">ssh_<wbr>user_<wbr>certificates</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshusercertificatelist.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateList.html#sshUserCertificates" class="tsd-kind-icon">ssh<wbr>User<wbr>Certificates</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateList.html#uri" class="tsd-kind-icon">uri</a></li>
86
89
  </ul>
87
90
  </section>
88
91
  </div>
@@ -91,12 +94,12 @@
91
94
  <section class="tsd-panel-group tsd-member-group ">
92
95
  <h2>Properties</h2>
93
96
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
94
- <a name="next_page_uri" class="tsd-anchor"></a>
95
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> next_<wbr>page_<wbr>uri</h3>
96
- <div class="tsd-signature tsd-kind-icon">next_<wbr>page_<wbr>uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
97
+ <a name="nextPageUri" class="tsd-anchor"></a>
98
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> next<wbr>Page<wbr>Uri</h3>
99
+ <div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
97
100
  <aside class="tsd-sources">
98
101
  <ul>
99
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1732">types.ts:1732</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1795">datatypes.ts:1795</a></li>
100
103
  </ul>
101
104
  </aside>
102
105
  <div class="tsd-comment tsd-typography">
@@ -106,12 +109,12 @@
106
109
  </div>
107
110
  </section>
108
111
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
109
- <a name="ssh_user_certificates" class="tsd-anchor"></a>
110
- <h3>ssh_<wbr>user_<wbr>certificates</h3>
111
- <div class="tsd-signature tsd-kind-icon">ssh_<wbr>user_<wbr>certificates<span class="tsd-signature-symbol">:</span> <a href="sshusercertificate.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHUserCertificate</a><span class="tsd-signature-symbol">[]</span></div>
112
+ <a name="sshUserCertificates" class="tsd-anchor"></a>
113
+ <h3>ssh<wbr>User<wbr>Certificates</h3>
114
+ <div class="tsd-signature tsd-kind-icon">ssh<wbr>User<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="datatypes.SSHUserCertificate.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHUserCertificate</a><span class="tsd-signature-symbol">[]</span></div>
112
115
  <aside class="tsd-sources">
113
116
  <ul>
114
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1728">types.ts:1728</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1791">datatypes.ts:1791</a></li>
115
118
  </ul>
116
119
  </aside>
117
120
  <div class="tsd-comment tsd-typography">
@@ -126,7 +129,7 @@
126
129
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
127
130
  <aside class="tsd-sources">
128
131
  <ul>
129
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1730">types.ts:1730</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1793">datatypes.ts:1793</a></li>
130
133
  </ul>
131
134
  </aside>
132
135
  <div class="tsd-comment tsd-typography">
@@ -141,7 +144,16 @@
141
144
  <nav class="tsd-navigation primary">
142
145
  <ul>
143
146
  <li class=" ">
144
- <a href="../modules.html">Exports</a>
147
+ <a href="../modules.html">Modules</a>
148
+ </li>
149
+ <li class=" tsd-kind-module">
150
+ <a href="../modules/client.html">client</a>
151
+ </li>
152
+ <li class="current tsd-kind-module">
153
+ <a href="../modules/datatypes.html">datatypes</a>
154
+ </li>
155
+ <li class=" tsd-kind-module">
156
+ <a href="../modules/services.html">services</a>
145
157
  </li>
146
158
  </ul>
147
159
  </nav>
@@ -149,17 +161,17 @@
149
161
  <ul class="before-current">
150
162
  </ul>
151
163
  <ul class="current">
152
- <li class="current tsd-kind-interface">
153
- <a href="sshusercertificatelist.html" class="tsd-kind-icon">SSHUser<wbr>Certificate<wbr>List</a>
164
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
165
+ <a href="datatypes.SSHUserCertificateList.html" class="tsd-kind-icon">SSHUser<wbr>Certificate<wbr>List</a>
154
166
  <ul>
155
167
  <li class=" tsd-kind-property tsd-parent-kind-interface">
156
- <a href="sshusercertificatelist.html#next_page_uri" class="tsd-kind-icon">next_<wbr>page_<wbr>uri</a>
168
+ <a href="datatypes.SSHUserCertificateList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a>
157
169
  </li>
158
170
  <li class=" tsd-kind-property tsd-parent-kind-interface">
159
- <a href="sshusercertificatelist.html#ssh_user_certificates" class="tsd-kind-icon">ssh_<wbr>user_<wbr>certificates</a>
171
+ <a href="datatypes.SSHUserCertificateList.html#sshUserCertificates" class="tsd-kind-icon">ssh<wbr>User<wbr>Certificates</a>
160
172
  </li>
161
173
  <li class=" tsd-kind-property tsd-parent-kind-interface">
162
- <a href="sshusercertificatelist.html#uri" class="tsd-kind-icon">uri</a>
174
+ <a href="datatypes.SSHUserCertificateList.html#uri" class="tsd-kind-icon">uri</a>
163
175
  </li>
164
176
  </ul>
165
177
  </li>
@@ -175,11 +187,11 @@
175
187
  <h2>Legend</h2>
176
188
  <div class="tsd-legend-group">
177
189
  <ul class="tsd-legend">
178
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
179
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
190
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
191
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
180
192
  </ul>
181
193
  <ul class="tsd-legend">
182
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
194
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
183
195
  </ul>
184
196
  </div>
185
197
  </div>
package/docs/interfaces/{sshusercertificateupdate.html → datatypes.SSHUserCertificateUpdate.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="sshusercertificateupdate.html">SSHUserCertificateUpdate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.SSHUserCertificateUpdate.html">SSHUserCertificateUpdate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface SSHUserCertificateUpdate</h1>
@@ -80,9 +83,9 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshusercertificateupdate.html#description" class="tsd-kind-icon">description</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshusercertificateupdate.html#id" class="tsd-kind-icon">id</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="sshusercertificateupdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateUpdate.html#description" class="tsd-kind-icon">description</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateUpdate.html#id" class="tsd-kind-icon">id</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
86
89
  </ul>
87
90
  </section>
88
91
  </div>
@@ -96,7 +99,7 @@
96
99
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
97
100
  <aside class="tsd-sources">
98
101
  <ul>
99
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1690">types.ts:1690</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1753">datatypes.ts:1753</a></li>
100
103
  </ul>
101
104
  </aside>
102
105
  <div class="tsd-comment tsd-typography">
@@ -111,7 +114,7 @@
111
114
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
112
115
  <aside class="tsd-sources">
113
116
  <ul>
114
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1688">types.ts:1688</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1751">datatypes.ts:1751</a></li>
115
118
  </ul>
116
119
  </aside>
117
120
  </section>
@@ -121,7 +124,7 @@
121
124
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
122
125
  <aside class="tsd-sources">
123
126
  <ul>
124
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1692">types.ts:1692</a></li>
127
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1755">datatypes.ts:1755</a></li>
125
128
  </ul>
126
129
  </aside>
127
130
  <div class="tsd-comment tsd-typography">
@@ -136,7 +139,16 @@
136
139
  <nav class="tsd-navigation primary">
137
140
  <ul>
138
141
  <li class=" ">
139
- <a href="../modules.html">Exports</a>
142
+ <a href="../modules.html">Modules</a>
143
+ </li>
144
+ <li class=" tsd-kind-module">
145
+ <a href="../modules/client.html">client</a>
146
+ </li>
147
+ <li class="current tsd-kind-module">
148
+ <a href="../modules/datatypes.html">datatypes</a>
149
+ </li>
150
+ <li class=" tsd-kind-module">
151
+ <a href="../modules/services.html">services</a>
140
152
  </li>
141
153
  </ul>
142
154
  </nav>
@@ -144,17 +156,17 @@
144
156
  <ul class="before-current">
145
157
  </ul>
146
158
  <ul class="current">
147
- <li class="current tsd-kind-interface">
148
- <a href="sshusercertificateupdate.html" class="tsd-kind-icon">SSHUser<wbr>Certificate<wbr>Update</a>
159
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
160
+ <a href="datatypes.SSHUserCertificateUpdate.html" class="tsd-kind-icon">SSHUser<wbr>Certificate<wbr>Update</a>
149
161
  <ul>
150
162
  <li class=" tsd-kind-property tsd-parent-kind-interface">
151
- <a href="sshusercertificateupdate.html#description" class="tsd-kind-icon">description</a>
163
+ <a href="datatypes.SSHUserCertificateUpdate.html#description" class="tsd-kind-icon">description</a>
152
164
  </li>
153
165
  <li class=" tsd-kind-property tsd-parent-kind-interface">
154
- <a href="sshusercertificateupdate.html#id" class="tsd-kind-icon">id</a>
166
+ <a href="datatypes.SSHUserCertificateUpdate.html#id" class="tsd-kind-icon">id</a>
155
167
  </li>
156
168
  <li class=" tsd-kind-property tsd-parent-kind-interface">
157
- <a href="sshusercertificateupdate.html#metadata" class="tsd-kind-icon">metadata</a>
169
+ <a href="datatypes.SSHUserCertificateUpdate.html#metadata" class="tsd-kind-icon">metadata</a>
158
170
  </li>
159
171
  </ul>
160
172
  </li>
@@ -170,11 +182,11 @@
170
182
  <h2>Legend</h2>
171
183
  <div class="tsd-legend-group">
172
184
  <ul class="tsd-legend">
173
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
174
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
185
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
186
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
175
187
  </ul>
176
188
  <ul class="tsd-legend">
177
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
189
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
178
190
  </ul>
179
191
  </div>
180
192
  </div>