@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/{certificateauthority.html → datatypes.CertificateAuthority.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="certificateauthority.html">CertificateAuthority</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.CertificateAuthority.html">CertificateAuthority</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface CertificateAuthority</h1>
@@ -80,17 +83,17 @@
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="certificateauthority.html#ca_pem" class="tsd-kind-icon">ca_<wbr>pem</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="certificateauthority.html#created_at" class="tsd-kind-icon">created_<wbr>at</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="certificateauthority.html#description" class="tsd-kind-icon">description</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="certificateauthority.html#extended_key_usages" class="tsd-kind-icon">extended_<wbr>key_<wbr>usages</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="certificateauthority.html#id" class="tsd-kind-icon">id</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="certificateauthority.html#key_usages" class="tsd-kind-icon">key_<wbr>usages</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="certificateauthority.html#metadata" class="tsd-kind-icon">metadata</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="certificateauthority.html#not_after" class="tsd-kind-icon">not_<wbr>after</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="certificateauthority.html#not_before" class="tsd-kind-icon">not_<wbr>before</a></li>
92
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="certificateauthority.html#subject_common_name" class="tsd-kind-icon">subject_<wbr>common_<wbr>name</a></li>
93
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="certificateauthority.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthority.html#caPem" class="tsd-kind-icon">ca<wbr>Pem</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthority.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthority.html#description" class="tsd-kind-icon">description</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthority.html#extendedKeyUsages" class="tsd-kind-icon">extended<wbr>Key<wbr>Usages</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthority.html#id" class="tsd-kind-icon">id</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthority.html#keyUsages" class="tsd-kind-icon">key<wbr>Usages</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthority.html#metadata" class="tsd-kind-icon">metadata</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthority.html#notAfter" class="tsd-kind-icon">not<wbr>After</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthority.html#notBefore" class="tsd-kind-icon">not<wbr>Before</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthority.html#subjectCommonName" class="tsd-kind-icon">subject<wbr>Common<wbr>Name</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthority.html#uri" class="tsd-kind-icon">uri</a></li>
94
97
  </ul>
95
98
  </section>
96
99
  </div>
@@ -99,12 +102,12 @@
99
102
  <section class="tsd-panel-group tsd-member-group ">
100
103
  <h2>Properties</h2>
101
104
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
102
- <a name="ca_pem" class="tsd-anchor"></a>
103
- <h3>ca_<wbr>pem</h3>
104
- <div class="tsd-signature tsd-kind-icon">ca_<wbr>pem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
105
+ <a name="caPem" class="tsd-anchor"></a>
106
+ <h3>ca<wbr>Pem</h3>
107
+ <div class="tsd-signature tsd-kind-icon">ca<wbr>Pem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
105
108
  <aside class="tsd-sources">
106
109
  <ul>
107
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L301">types.ts:301</a></li>
110
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L353">datatypes.ts:353</a></li>
108
111
  </ul>
109
112
  </aside>
110
113
  <div class="tsd-comment tsd-typography">
@@ -114,12 +117,12 @@
114
117
  </div>
115
118
  </section>
116
119
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
117
- <a name="created_at" class="tsd-anchor"></a>
118
- <h3>created_<wbr>at</h3>
119
- <div class="tsd-signature tsd-kind-icon">created_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
120
+ <a name="createdAt" class="tsd-anchor"></a>
121
+ <h3>created<wbr>At</h3>
122
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
120
123
  <aside class="tsd-sources">
121
124
  <ul>
122
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L295">types.ts:295</a></li>
125
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L347">datatypes.ts:347</a></li>
123
126
  </ul>
124
127
  </aside>
125
128
  <div class="tsd-comment tsd-typography">
@@ -134,7 +137,7 @@
134
137
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
135
138
  <aside class="tsd-sources">
136
139
  <ul>
137
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L297">types.ts:297</a></li>
140
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L349">datatypes.ts:349</a></li>
138
141
  </ul>
139
142
  </aside>
140
143
  <div class="tsd-comment tsd-typography">
@@ -144,12 +147,12 @@
144
147
  </div>
145
148
  </section>
146
149
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
147
- <a name="extended_key_usages" class="tsd-anchor"></a>
148
- <h3>extended_<wbr>key_<wbr>usages</h3>
149
- <div class="tsd-signature tsd-kind-icon">extended_<wbr>key_<wbr>usages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
150
+ <a name="extendedKeyUsages" class="tsd-anchor"></a>
151
+ <h3>extended<wbr>Key<wbr>Usages</h3>
152
+ <div class="tsd-signature tsd-kind-icon">extended<wbr>Key<wbr>Usages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
150
153
  <aside class="tsd-sources">
151
154
  <ul>
152
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L311">types.ts:311</a></li>
155
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L363">datatypes.ts:363</a></li>
153
156
  </ul>
154
157
  </aside>
155
158
  <div class="tsd-comment tsd-typography">
@@ -164,7 +167,7 @@
164
167
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
165
168
  <aside class="tsd-sources">
166
169
  <ul>
167
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L291">types.ts:291</a></li>
170
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L343">datatypes.ts:343</a></li>
168
171
  </ul>
169
172
  </aside>
170
173
  <div class="tsd-comment tsd-typography">
@@ -174,12 +177,12 @@
174
177
  </div>
175
178
  </section>
176
179
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
177
- <a name="key_usages" class="tsd-anchor"></a>
178
- <h3>key_<wbr>usages</h3>
179
- <div class="tsd-signature tsd-kind-icon">key_<wbr>usages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
180
+ <a name="keyUsages" class="tsd-anchor"></a>
181
+ <h3>key<wbr>Usages</h3>
182
+ <div class="tsd-signature tsd-kind-icon">key<wbr>Usages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
180
183
  <aside class="tsd-sources">
181
184
  <ul>
182
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L309">types.ts:309</a></li>
185
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L361">datatypes.ts:361</a></li>
183
186
  </ul>
184
187
  </aside>
185
188
  <div class="tsd-comment tsd-typography">
@@ -194,7 +197,7 @@
194
197
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
195
198
  <aside class="tsd-sources">
196
199
  <ul>
197
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L299">types.ts:299</a></li>
200
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L351">datatypes.ts:351</a></li>
198
201
  </ul>
199
202
  </aside>
200
203
  <div class="tsd-comment tsd-typography">
@@ -204,12 +207,12 @@
204
207
  </div>
205
208
  </section>
206
209
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
207
- <a name="not_after" class="tsd-anchor"></a>
208
- <h3>not_<wbr>after</h3>
209
- <div class="tsd-signature tsd-kind-icon">not_<wbr>after<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
210
+ <a name="notAfter" class="tsd-anchor"></a>
211
+ <h3>not<wbr>After</h3>
212
+ <div class="tsd-signature tsd-kind-icon">not<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
210
213
  <aside class="tsd-sources">
211
214
  <ul>
212
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L307">types.ts:307</a></li>
215
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L359">datatypes.ts:359</a></li>
213
216
  </ul>
214
217
  </aside>
215
218
  <div class="tsd-comment tsd-typography">
@@ -219,12 +222,12 @@
219
222
  </div>
220
223
  </section>
221
224
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
222
- <a name="not_before" class="tsd-anchor"></a>
223
- <h3>not_<wbr>before</h3>
224
- <div class="tsd-signature tsd-kind-icon">not_<wbr>before<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
225
+ <a name="notBefore" class="tsd-anchor"></a>
226
+ <h3>not<wbr>Before</h3>
227
+ <div class="tsd-signature tsd-kind-icon">not<wbr>Before<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
225
228
  <aside class="tsd-sources">
226
229
  <ul>
227
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L305">types.ts:305</a></li>
230
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L357">datatypes.ts:357</a></li>
228
231
  </ul>
229
232
  </aside>
230
233
  <div class="tsd-comment tsd-typography">
@@ -234,12 +237,12 @@
234
237
  </div>
235
238
  </section>
236
239
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
237
- <a name="subject_common_name" class="tsd-anchor"></a>
238
- <h3>subject_<wbr>common_<wbr>name</h3>
239
- <div class="tsd-signature tsd-kind-icon">subject_<wbr>common_<wbr>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
240
+ <a name="subjectCommonName" class="tsd-anchor"></a>
241
+ <h3>subject<wbr>Common<wbr>Name</h3>
242
+ <div class="tsd-signature tsd-kind-icon">subject<wbr>Common<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
240
243
  <aside class="tsd-sources">
241
244
  <ul>
242
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L303">types.ts:303</a></li>
245
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L355">datatypes.ts:355</a></li>
243
246
  </ul>
244
247
  </aside>
245
248
  <div class="tsd-comment tsd-typography">
@@ -254,7 +257,7 @@
254
257
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
255
258
  <aside class="tsd-sources">
256
259
  <ul>
257
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L293">types.ts:293</a></li>
260
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L345">datatypes.ts:345</a></li>
258
261
  </ul>
259
262
  </aside>
260
263
  <div class="tsd-comment tsd-typography">
@@ -269,7 +272,16 @@
269
272
  <nav class="tsd-navigation primary">
270
273
  <ul>
271
274
  <li class=" ">
272
- <a href="../modules.html">Exports</a>
275
+ <a href="../modules.html">Modules</a>
276
+ </li>
277
+ <li class=" tsd-kind-module">
278
+ <a href="../modules/client.html">client</a>
279
+ </li>
280
+ <li class="current tsd-kind-module">
281
+ <a href="../modules/datatypes.html">datatypes</a>
282
+ </li>
283
+ <li class=" tsd-kind-module">
284
+ <a href="../modules/services.html">services</a>
273
285
  </li>
274
286
  </ul>
275
287
  </nav>
@@ -277,41 +289,41 @@
277
289
  <ul class="before-current">
278
290
  </ul>
279
291
  <ul class="current">
280
- <li class="current tsd-kind-interface">
281
- <a href="certificateauthority.html" class="tsd-kind-icon">Certificate<wbr>Authority</a>
292
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
293
+ <a href="datatypes.CertificateAuthority.html" class="tsd-kind-icon">Certificate<wbr>Authority</a>
282
294
  <ul>
283
295
  <li class=" tsd-kind-property tsd-parent-kind-interface">
284
- <a href="certificateauthority.html#ca_pem" class="tsd-kind-icon">ca_<wbr>pem</a>
296
+ <a href="datatypes.CertificateAuthority.html#caPem" class="tsd-kind-icon">ca<wbr>Pem</a>
285
297
  </li>
286
298
  <li class=" tsd-kind-property tsd-parent-kind-interface">
287
- <a href="certificateauthority.html#created_at" class="tsd-kind-icon">created_<wbr>at</a>
299
+ <a href="datatypes.CertificateAuthority.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
288
300
  </li>
289
301
  <li class=" tsd-kind-property tsd-parent-kind-interface">
290
- <a href="certificateauthority.html#description" class="tsd-kind-icon">description</a>
302
+ <a href="datatypes.CertificateAuthority.html#description" class="tsd-kind-icon">description</a>
291
303
  </li>
292
304
  <li class=" tsd-kind-property tsd-parent-kind-interface">
293
- <a href="certificateauthority.html#extended_key_usages" class="tsd-kind-icon">extended_<wbr>key_<wbr>usages</a>
305
+ <a href="datatypes.CertificateAuthority.html#extendedKeyUsages" class="tsd-kind-icon">extended<wbr>Key<wbr>Usages</a>
294
306
  </li>
295
307
  <li class=" tsd-kind-property tsd-parent-kind-interface">
296
- <a href="certificateauthority.html#id" class="tsd-kind-icon">id</a>
308
+ <a href="datatypes.CertificateAuthority.html#id" class="tsd-kind-icon">id</a>
297
309
  </li>
298
310
  <li class=" tsd-kind-property tsd-parent-kind-interface">
299
- <a href="certificateauthority.html#key_usages" class="tsd-kind-icon">key_<wbr>usages</a>
311
+ <a href="datatypes.CertificateAuthority.html#keyUsages" class="tsd-kind-icon">key<wbr>Usages</a>
300
312
  </li>
301
313
  <li class=" tsd-kind-property tsd-parent-kind-interface">
302
- <a href="certificateauthority.html#metadata" class="tsd-kind-icon">metadata</a>
314
+ <a href="datatypes.CertificateAuthority.html#metadata" class="tsd-kind-icon">metadata</a>
303
315
  </li>
304
316
  <li class=" tsd-kind-property tsd-parent-kind-interface">
305
- <a href="certificateauthority.html#not_after" class="tsd-kind-icon">not_<wbr>after</a>
317
+ <a href="datatypes.CertificateAuthority.html#notAfter" class="tsd-kind-icon">not<wbr>After</a>
306
318
  </li>
307
319
  <li class=" tsd-kind-property tsd-parent-kind-interface">
308
- <a href="certificateauthority.html#not_before" class="tsd-kind-icon">not_<wbr>before</a>
320
+ <a href="datatypes.CertificateAuthority.html#notBefore" class="tsd-kind-icon">not<wbr>Before</a>
309
321
  </li>
310
322
  <li class=" tsd-kind-property tsd-parent-kind-interface">
311
- <a href="certificateauthority.html#subject_common_name" class="tsd-kind-icon">subject_<wbr>common_<wbr>name</a>
323
+ <a href="datatypes.CertificateAuthority.html#subjectCommonName" class="tsd-kind-icon">subject<wbr>Common<wbr>Name</a>
312
324
  </li>
313
325
  <li class=" tsd-kind-property tsd-parent-kind-interface">
314
- <a href="certificateauthority.html#uri" class="tsd-kind-icon">uri</a>
326
+ <a href="datatypes.CertificateAuthority.html#uri" class="tsd-kind-icon">uri</a>
315
327
  </li>
316
328
  </ul>
317
329
  </li>
@@ -327,11 +339,11 @@
327
339
  <h2>Legend</h2>
328
340
  <div class="tsd-legend-group">
329
341
  <ul class="tsd-legend">
330
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
331
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
342
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
343
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
332
344
  </ul>
333
345
  <ul class="tsd-legend">
334
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
346
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
335
347
  </ul>
336
348
  </div>
337
349
  </div>
package/docs/interfaces/{certificateauthoritycreate.html → datatypes.CertificateAuthorityCreate.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="certificateauthoritycreate.html">CertificateAuthorityCreate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.CertificateAuthorityCreate.html">CertificateAuthorityCreate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface CertificateAuthorityCreate</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="certificateauthoritycreate.html#ca_pem" class="tsd-kind-icon">ca_<wbr>pem</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="certificateauthoritycreate.html#description" class="tsd-kind-icon">description</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="certificateauthoritycreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthorityCreate.html#caPem" class="tsd-kind-icon">ca<wbr>Pem</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthorityCreate.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthorityCreate.html#metadata" class="tsd-kind-icon">metadata</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="ca_pem" class="tsd-anchor"></a>
95
- <h3>ca_<wbr>pem</h3>
96
- <div class="tsd-signature tsd-kind-icon">ca_<wbr>pem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
97
+ <a name="caPem" class="tsd-anchor"></a>
98
+ <h3>ca<wbr>Pem</h3>
99
+ <div class="tsd-signature tsd-kind-icon">ca<wbr>Pem<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#L278">types.ts:278</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L330">datatypes.ts:330</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">description<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#L274">types.ts:274</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L326">datatypes.ts:326</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">metadata<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#L276">types.ts:276</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L328">datatypes.ts:328</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="certificateauthoritycreate.html" class="tsd-kind-icon">Certificate<wbr>Authority<wbr>Create</a>
164
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
165
+ <a href="datatypes.CertificateAuthorityCreate.html" class="tsd-kind-icon">Certificate<wbr>Authority<wbr>Create</a>
154
166
  <ul>
155
167
  <li class=" tsd-kind-property tsd-parent-kind-interface">
156
- <a href="certificateauthoritycreate.html#ca_pem" class="tsd-kind-icon">ca_<wbr>pem</a>
168
+ <a href="datatypes.CertificateAuthorityCreate.html#caPem" class="tsd-kind-icon">ca<wbr>Pem</a>
157
169
  </li>
158
170
  <li class=" tsd-kind-property tsd-parent-kind-interface">
159
- <a href="certificateauthoritycreate.html#description" class="tsd-kind-icon">description</a>
171
+ <a href="datatypes.CertificateAuthorityCreate.html#description" class="tsd-kind-icon">description</a>
160
172
  </li>
161
173
  <li class=" tsd-kind-property tsd-parent-kind-interface">
162
- <a href="certificateauthoritycreate.html#metadata" class="tsd-kind-icon">metadata</a>
174
+ <a href="datatypes.CertificateAuthorityCreate.html#metadata" class="tsd-kind-icon">metadata</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/{certificateauthoritylist.html → datatypes.CertificateAuthorityList.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="certificateauthoritylist.html">CertificateAuthorityList</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.CertificateAuthorityList.html">CertificateAuthorityList</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface CertificateAuthorityList</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="certificateauthoritylist.html#certificate_authorities" class="tsd-kind-icon">certificate_<wbr>authorities</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="certificateauthoritylist.html#next_page_uri" class="tsd-kind-icon">next_<wbr>page_<wbr>uri</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="certificateauthoritylist.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthorityList.html#certificateAuthorities" class="tsd-kind-icon">certificate<wbr>Authorities</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthorityList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CertificateAuthorityList.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="certificate_authorities" class="tsd-anchor"></a>
95
- <h3>certificate_<wbr>authorities</h3>
96
- <div class="tsd-signature tsd-kind-icon">certificate_<wbr>authorities<span class="tsd-signature-symbol">:</span> <a href="certificateauthority.html" class="tsd-signature-type" data-tsd-kind="Interface">CertificateAuthority</a><span class="tsd-signature-symbol">[]</span></div>
97
+ <a name="certificateAuthorities" class="tsd-anchor"></a>
98
+ <h3>certificate<wbr>Authorities</h3>
99
+ <div class="tsd-signature tsd-kind-icon">certificate<wbr>Authorities<span class="tsd-signature-symbol">:</span> <a href="datatypes.CertificateAuthority.html" class="tsd-signature-type" data-tsd-kind="Interface">CertificateAuthority</a><span class="tsd-signature-symbol">[]</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#L316">types.ts:316</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L368">datatypes.ts:368</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="next_page_uri" class="tsd-anchor"></a>
110
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> next_<wbr>page_<wbr>uri</h3>
111
- <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>
112
+ <a name="nextPageUri" class="tsd-anchor"></a>
113
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> next<wbr>Page<wbr>Uri</h3>
114
+ <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>
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#L320">types.ts:320</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L372">datatypes.ts:372</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#L318">types.ts:318</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L370">datatypes.ts:370</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="certificateauthoritylist.html" class="tsd-kind-icon">Certificate<wbr>Authority<wbr>List</a>
164
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
165
+ <a href="datatypes.CertificateAuthorityList.html" class="tsd-kind-icon">Certificate<wbr>Authority<wbr>List</a>
154
166
  <ul>
155
167
  <li class=" tsd-kind-property tsd-parent-kind-interface">
156
- <a href="certificateauthoritylist.html#certificate_authorities" class="tsd-kind-icon">certificate_<wbr>authorities</a>
168
+ <a href="datatypes.CertificateAuthorityList.html#certificateAuthorities" class="tsd-kind-icon">certificate<wbr>Authorities</a>
157
169
  </li>
158
170
  <li class=" tsd-kind-property tsd-parent-kind-interface">
159
- <a href="certificateauthoritylist.html#next_page_uri" class="tsd-kind-icon">next_<wbr>page_<wbr>uri</a>
171
+ <a href="datatypes.CertificateAuthorityList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a>
160
172
  </li>
161
173
  <li class=" tsd-kind-property tsd-parent-kind-interface">
162
- <a href="certificateauthoritylist.html#uri" class="tsd-kind-icon">uri</a>
174
+ <a href="datatypes.CertificateAuthorityList.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>