@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/{reserveddomaincertjob.html → datatypes.ReservedDomainCertJob.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="reserveddomaincertjob.html">ReservedDomainCertJob</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.ReservedDomainCertJob.html">ReservedDomainCertJob</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface ReservedDomainCertJob</h1>
@@ -80,11 +83,10 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomaincertjob.html#error_code" class="tsd-kind-icon">error_<wbr>code</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomaincertjob.html#msg" class="tsd-kind-icon">msg</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomaincertjob.html#ns_targets" class="tsd-kind-icon">ns_<wbr>targets</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomaincertjob.html#retries_at" class="tsd-kind-icon">retries_<wbr>at</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomaincertjob.html#started_at" class="tsd-kind-icon">started_<wbr>at</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCertJob.html#errorCode" class="tsd-kind-icon">error<wbr>Code</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCertJob.html#msg" class="tsd-kind-icon">msg</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCertJob.html#retriesAt" class="tsd-kind-icon">retries<wbr>At</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCertJob.html#startedAt" class="tsd-kind-icon">started<wbr>At</a></li>
88
90
  </ul>
89
91
  </section>
90
92
  </div>
@@ -93,12 +95,12 @@
93
95
  <section class="tsd-panel-group tsd-member-group ">
94
96
  <h2>Properties</h2>
95
97
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
96
- <a name="error_code" class="tsd-anchor"></a>
97
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> error_<wbr>code</h3>
98
- <div class="tsd-signature tsd-kind-icon">error_<wbr>code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
98
+ <a name="errorCode" class="tsd-anchor"></a>
99
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> error<wbr>Code</h3>
100
+ <div class="tsd-signature tsd-kind-icon">error<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
101
  <aside class="tsd-sources">
100
102
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1495">types.ts:1495</a></li>
103
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1565">datatypes.ts:1565</a></li>
102
104
  </ul>
103
105
  </aside>
104
106
  <div class="tsd-comment tsd-typography">
@@ -113,7 +115,7 @@
113
115
  <div class="tsd-signature tsd-kind-icon">msg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
114
116
  <aside class="tsd-sources">
115
117
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1497">types.ts:1497</a></li>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1567">datatypes.ts:1567</a></li>
117
119
  </ul>
118
120
  </aside>
119
121
  <div class="tsd-comment tsd-typography">
@@ -123,27 +125,12 @@
123
125
  </div>
124
126
  </section>
125
127
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
126
- <a name="ns_targets" class="tsd-anchor"></a>
127
- <h3>ns_<wbr>targets</h3>
128
- <div class="tsd-signature tsd-kind-icon">ns_<wbr>targets<span class="tsd-signature-symbol">:</span> <a href="reserveddomaincertnstarget.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomainCertNSTarget</a><span class="tsd-signature-symbol">[]</span></div>
128
+ <a name="retriesAt" class="tsd-anchor"></a>
129
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> retries<wbr>At</h3>
130
+ <div class="tsd-signature tsd-kind-icon">retries<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
129
131
  <aside class="tsd-sources">
130
132
  <ul>
131
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1503">types.ts:1503</a></li>
132
- </ul>
133
- </aside>
134
- <div class="tsd-comment tsd-typography">
135
- <div class="lead">
136
- <p>if present, indicates the dns nameservers that the user must configure to complete the provisioning process of a wildcard certificate</p>
137
- </div>
138
- </div>
139
- </section>
140
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
141
- <a name="retries_at" class="tsd-anchor"></a>
142
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> retries_<wbr>at</h3>
143
- <div class="tsd-signature tsd-kind-icon">retries_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
144
- <aside class="tsd-sources">
145
- <ul>
146
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1501">types.ts:1501</a></li>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1571">datatypes.ts:1571</a></li>
147
134
  </ul>
148
135
  </aside>
149
136
  <div class="tsd-comment tsd-typography">
@@ -153,12 +140,12 @@
153
140
  </div>
154
141
  </section>
155
142
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
156
- <a name="started_at" class="tsd-anchor"></a>
157
- <h3>started_<wbr>at</h3>
158
- <div class="tsd-signature tsd-kind-icon">started_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
143
+ <a name="startedAt" class="tsd-anchor"></a>
144
+ <h3>started<wbr>At</h3>
145
+ <div class="tsd-signature tsd-kind-icon">started<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
159
146
  <aside class="tsd-sources">
160
147
  <ul>
161
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1499">types.ts:1499</a></li>
148
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1569">datatypes.ts:1569</a></li>
162
149
  </ul>
163
150
  </aside>
164
151
  <div class="tsd-comment tsd-typography">
@@ -173,7 +160,16 @@
173
160
  <nav class="tsd-navigation primary">
174
161
  <ul>
175
162
  <li class=" ">
176
- <a href="../modules.html">Exports</a>
163
+ <a href="../modules.html">Modules</a>
164
+ </li>
165
+ <li class=" tsd-kind-module">
166
+ <a href="../modules/client.html">client</a>
167
+ </li>
168
+ <li class="current tsd-kind-module">
169
+ <a href="../modules/datatypes.html">datatypes</a>
170
+ </li>
171
+ <li class=" tsd-kind-module">
172
+ <a href="../modules/services.html">services</a>
177
173
  </li>
178
174
  </ul>
179
175
  </nav>
@@ -181,23 +177,20 @@
181
177
  <ul class="before-current">
182
178
  </ul>
183
179
  <ul class="current">
184
- <li class="current tsd-kind-interface">
185
- <a href="reserveddomaincertjob.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Cert<wbr>Job</a>
180
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
181
+ <a href="datatypes.ReservedDomainCertJob.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Cert<wbr>Job</a>
186
182
  <ul>
187
183
  <li class=" tsd-kind-property tsd-parent-kind-interface">
188
- <a href="reserveddomaincertjob.html#error_code" class="tsd-kind-icon">error_<wbr>code</a>
184
+ <a href="datatypes.ReservedDomainCertJob.html#errorCode" class="tsd-kind-icon">error<wbr>Code</a>
189
185
  </li>
190
186
  <li class=" tsd-kind-property tsd-parent-kind-interface">
191
- <a href="reserveddomaincertjob.html#msg" class="tsd-kind-icon">msg</a>
187
+ <a href="datatypes.ReservedDomainCertJob.html#msg" class="tsd-kind-icon">msg</a>
192
188
  </li>
193
189
  <li class=" tsd-kind-property tsd-parent-kind-interface">
194
- <a href="reserveddomaincertjob.html#ns_targets" class="tsd-kind-icon">ns_<wbr>targets</a>
190
+ <a href="datatypes.ReservedDomainCertJob.html#retriesAt" class="tsd-kind-icon">retries<wbr>At</a>
195
191
  </li>
196
192
  <li class=" tsd-kind-property tsd-parent-kind-interface">
197
- <a href="reserveddomaincertjob.html#retries_at" class="tsd-kind-icon">retries_<wbr>at</a>
198
- </li>
199
- <li class=" tsd-kind-property tsd-parent-kind-interface">
200
- <a href="reserveddomaincertjob.html#started_at" class="tsd-kind-icon">started_<wbr>at</a>
193
+ <a href="datatypes.ReservedDomainCertJob.html#startedAt" class="tsd-kind-icon">started<wbr>At</a>
201
194
  </li>
202
195
  </ul>
203
196
  </li>
@@ -213,11 +206,11 @@
213
206
  <h2>Legend</h2>
214
207
  <div class="tsd-legend-group">
215
208
  <ul class="tsd-legend">
216
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
217
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
209
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
210
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
218
211
  </ul>
219
212
  <ul class="tsd-legend">
220
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
213
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
221
214
  </ul>
222
215
  </div>
223
216
  </div>
package/docs/interfaces/{reserveddomaincertpolicy.html → datatypes.ReservedDomainCertPolicy.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="reserveddomaincertpolicy.html">ReservedDomainCertPolicy</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.ReservedDomainCertPolicy.html">ReservedDomainCertPolicy</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface ReservedDomainCertPolicy</h1>
@@ -80,8 +83,8 @@
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="reserveddomaincertpolicy.html#authority" class="tsd-kind-icon">authority</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomaincertpolicy.html#private_key_type" class="tsd-kind-icon">private_<wbr>key_<wbr>type</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCertPolicy.html#authority" class="tsd-kind-icon">authority</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCertPolicy.html#privateKeyType" class="tsd-kind-icon">private<wbr>Key<wbr>Type</a></li>
85
88
  </ul>
86
89
  </section>
87
90
  </div>
@@ -95,7 +98,7 @@
95
98
  <div class="tsd-signature tsd-kind-icon">authority<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
96
99
  <aside class="tsd-sources">
97
100
  <ul>
98
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1474">types.ts:1474</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1551">datatypes.ts:1551</a></li>
99
102
  </ul>
100
103
  </aside>
101
104
  <div class="tsd-comment tsd-typography">
@@ -105,12 +108,12 @@
105
108
  </div>
106
109
  </section>
107
110
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
108
- <a name="private_key_type" class="tsd-anchor"></a>
109
- <h3>private_<wbr>key_<wbr>type</h3>
110
- <div class="tsd-signature tsd-kind-icon">private_<wbr>key_<wbr>type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
111
+ <a name="privateKeyType" class="tsd-anchor"></a>
112
+ <h3>private<wbr>Key<wbr>Type</h3>
113
+ <div class="tsd-signature tsd-kind-icon">private<wbr>Key<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
111
114
  <aside class="tsd-sources">
112
115
  <ul>
113
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1476">types.ts:1476</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1553">datatypes.ts:1553</a></li>
114
117
  </ul>
115
118
  </aside>
116
119
  <div class="tsd-comment tsd-typography">
@@ -125,7 +128,16 @@
125
128
  <nav class="tsd-navigation primary">
126
129
  <ul>
127
130
  <li class=" ">
128
- <a href="../modules.html">Exports</a>
131
+ <a href="../modules.html">Modules</a>
132
+ </li>
133
+ <li class=" tsd-kind-module">
134
+ <a href="../modules/client.html">client</a>
135
+ </li>
136
+ <li class="current tsd-kind-module">
137
+ <a href="../modules/datatypes.html">datatypes</a>
138
+ </li>
139
+ <li class=" tsd-kind-module">
140
+ <a href="../modules/services.html">services</a>
129
141
  </li>
130
142
  </ul>
131
143
  </nav>
@@ -133,14 +145,14 @@
133
145
  <ul class="before-current">
134
146
  </ul>
135
147
  <ul class="current">
136
- <li class="current tsd-kind-interface">
137
- <a href="reserveddomaincertpolicy.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Cert<wbr>Policy</a>
148
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
149
+ <a href="datatypes.ReservedDomainCertPolicy.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Cert<wbr>Policy</a>
138
150
  <ul>
139
151
  <li class=" tsd-kind-property tsd-parent-kind-interface">
140
- <a href="reserveddomaincertpolicy.html#authority" class="tsd-kind-icon">authority</a>
152
+ <a href="datatypes.ReservedDomainCertPolicy.html#authority" class="tsd-kind-icon">authority</a>
141
153
  </li>
142
154
  <li class=" tsd-kind-property tsd-parent-kind-interface">
143
- <a href="reserveddomaincertpolicy.html#private_key_type" class="tsd-kind-icon">private_<wbr>key_<wbr>type</a>
155
+ <a href="datatypes.ReservedDomainCertPolicy.html#privateKeyType" class="tsd-kind-icon">private<wbr>Key<wbr>Type</a>
144
156
  </li>
145
157
  </ul>
146
158
  </li>
@@ -156,11 +168,11 @@
156
168
  <h2>Legend</h2>
157
169
  <div class="tsd-legend-group">
158
170
  <ul class="tsd-legend">
159
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
160
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
171
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
172
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
161
173
  </ul>
162
174
  <ul class="tsd-legend">
163
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
175
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
164
176
  </ul>
165
177
  </div>
166
178
  </div>
package/docs/interfaces/{reserveddomaincertstatus.html → datatypes.ReservedDomainCertStatus.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="reserveddomaincertstatus.html">ReservedDomainCertStatus</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.ReservedDomainCertStatus.html">ReservedDomainCertStatus</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface ReservedDomainCertStatus</h1>
@@ -80,8 +83,8 @@
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="reserveddomaincertstatus.html#provisioning_job" class="tsd-kind-icon">provisioning_<wbr>job</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomaincertstatus.html#renews_at" class="tsd-kind-icon">renews_<wbr>at</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCertStatus.html#provisioningJob" class="tsd-kind-icon">provisioning<wbr>Job</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCertStatus.html#renewsAt" class="tsd-kind-icon">renews<wbr>At</a></li>
85
88
  </ul>
86
89
  </section>
87
90
  </div>
@@ -90,12 +93,12 @@
90
93
  <section class="tsd-panel-group tsd-member-group ">
91
94
  <h2>Properties</h2>
92
95
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
93
- <a name="provisioning_job" class="tsd-anchor"></a>
94
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> provisioning_<wbr>job</h3>
95
- <div class="tsd-signature tsd-kind-icon">provisioning_<wbr>job<span class="tsd-signature-symbol">:</span> <a href="reserveddomaincertjob.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomainCertJob</a></div>
96
+ <a name="provisioningJob" class="tsd-anchor"></a>
97
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> provisioning<wbr>Job</h3>
98
+ <div class="tsd-signature tsd-kind-icon">provisioning<wbr>Job<span class="tsd-signature-symbol">:</span> <a href="datatypes.ReservedDomainCertJob.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomainCertJob</a></div>
96
99
  <aside class="tsd-sources">
97
100
  <ul>
98
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1483">types.ts:1483</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1560">datatypes.ts:1560</a></li>
99
102
  </ul>
100
103
  </aside>
101
104
  <div class="tsd-comment tsd-typography">
@@ -105,12 +108,12 @@
105
108
  </div>
106
109
  </section>
107
110
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
108
- <a name="renews_at" class="tsd-anchor"></a>
109
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> renews_<wbr>at</h3>
110
- <div class="tsd-signature tsd-kind-icon">renews_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
111
+ <a name="renewsAt" class="tsd-anchor"></a>
112
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> renews<wbr>At</h3>
113
+ <div class="tsd-signature tsd-kind-icon">renews<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
111
114
  <aside class="tsd-sources">
112
115
  <ul>
113
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1481">types.ts:1481</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1558">datatypes.ts:1558</a></li>
114
117
  </ul>
115
118
  </aside>
116
119
  <div class="tsd-comment tsd-typography">
@@ -125,7 +128,16 @@
125
128
  <nav class="tsd-navigation primary">
126
129
  <ul>
127
130
  <li class=" ">
128
- <a href="../modules.html">Exports</a>
131
+ <a href="../modules.html">Modules</a>
132
+ </li>
133
+ <li class=" tsd-kind-module">
134
+ <a href="../modules/client.html">client</a>
135
+ </li>
136
+ <li class="current tsd-kind-module">
137
+ <a href="../modules/datatypes.html">datatypes</a>
138
+ </li>
139
+ <li class=" tsd-kind-module">
140
+ <a href="../modules/services.html">services</a>
129
141
  </li>
130
142
  </ul>
131
143
  </nav>
@@ -133,14 +145,14 @@
133
145
  <ul class="before-current">
134
146
  </ul>
135
147
  <ul class="current">
136
- <li class="current tsd-kind-interface">
137
- <a href="reserveddomaincertstatus.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Cert<wbr>Status</a>
148
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
149
+ <a href="datatypes.ReservedDomainCertStatus.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Cert<wbr>Status</a>
138
150
  <ul>
139
151
  <li class=" tsd-kind-property tsd-parent-kind-interface">
140
- <a href="reserveddomaincertstatus.html#provisioning_job" class="tsd-kind-icon">provisioning_<wbr>job</a>
152
+ <a href="datatypes.ReservedDomainCertStatus.html#provisioningJob" class="tsd-kind-icon">provisioning<wbr>Job</a>
141
153
  </li>
142
154
  <li class=" tsd-kind-property tsd-parent-kind-interface">
143
- <a href="reserveddomaincertstatus.html#renews_at" class="tsd-kind-icon">renews_<wbr>at</a>
155
+ <a href="datatypes.ReservedDomainCertStatus.html#renewsAt" class="tsd-kind-icon">renews<wbr>At</a>
144
156
  </li>
145
157
  </ul>
146
158
  </li>
@@ -156,11 +168,11 @@
156
168
  <h2>Legend</h2>
157
169
  <div class="tsd-legend-group">
158
170
  <ul class="tsd-legend">
159
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
160
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
171
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
172
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
161
173
  </ul>
162
174
  <ul class="tsd-legend">
163
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
175
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
164
176
  </ul>
165
177
  </div>
166
178
  </div>
package/docs/interfaces/{reserveddomaincreate.html → datatypes.ReservedDomainCreate.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="reserveddomaincreate.html">ReservedDomainCreate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.ReservedDomainCreate.html">ReservedDomainCreate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface ReservedDomainCreate</h1>
@@ -80,14 +83,12 @@
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="reserveddomaincreate.html#certificate_id" class="tsd-kind-icon">certificate_<wbr>id</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomaincreate.html#certificate_management_policy" class="tsd-kind-icon">certificate_<wbr>management_<wbr>policy</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomaincreate.html#description" class="tsd-kind-icon">description</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomaincreate.html#http_endpoint_configuration_id" class="tsd-kind-icon">http_<wbr>endpoint_<wbr>configuration_<wbr>id</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomaincreate.html#https_endpoint_configuration_id" class="tsd-kind-icon">https_<wbr>endpoint_<wbr>configuration_<wbr>id</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomaincreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomaincreate.html#name" class="tsd-kind-icon">name</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomaincreate.html#region" class="tsd-kind-icon">region</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCreate.html#certificateId" class="tsd-kind-icon">certificate<wbr>Id</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCreate.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCreate.html#description" class="tsd-kind-icon">description</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCreate.html#name" class="tsd-kind-icon">name</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCreate.html#region" class="tsd-kind-icon">region</a></li>
91
92
  </ul>
92
93
  </section>
93
94
  </div>
@@ -96,32 +97,32 @@
96
97
  <section class="tsd-panel-group tsd-member-group ">
97
98
  <h2>Properties</h2>
98
99
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
99
- <a name="certificate_id" class="tsd-anchor"></a>
100
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate_<wbr>id</h3>
101
- <div class="tsd-signature tsd-kind-icon">certificate_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
+ <a name="certificateId" class="tsd-anchor"></a>
101
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate<wbr>Id</h3>
102
+ <div class="tsd-signature tsd-kind-icon">certificate<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
102
103
  <aside class="tsd-sources">
103
104
  <ul>
104
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1413">types.ts:1413</a></li>
105
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1496">datatypes.ts:1496</a></li>
105
106
  </ul>
106
107
  </aside>
107
108
  <div class="tsd-comment tsd-typography">
108
109
  <div class="lead">
109
- <p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.</p>
110
+ <p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code>certificate_management_policy</code>.</p>
110
111
  </div>
111
112
  </div>
112
113
  </section>
113
114
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
114
- <a name="certificate_management_policy" class="tsd-anchor"></a>
115
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate_<wbr>management_<wbr>policy</h3>
116
- <div class="tsd-signature tsd-kind-icon">certificate_<wbr>management_<wbr>policy<span class="tsd-signature-symbol">:</span> <a href="reserveddomaincertpolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomainCertPolicy</a></div>
115
+ <a name="certificateManagementPolicy" class="tsd-anchor"></a>
116
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate<wbr>Management<wbr>Policy</h3>
117
+ <div class="tsd-signature tsd-kind-icon">certificate<wbr>Management<wbr>Policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.ReservedDomainCertPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomainCertPolicy</a></div>
117
118
  <aside class="tsd-sources">
118
119
  <ul>
119
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1415">types.ts:1415</a></li>
120
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1498">datatypes.ts:1498</a></li>
120
121
  </ul>
121
122
  </aside>
122
123
  <div class="tsd-comment tsd-typography">
123
124
  <div class="lead">
124
- <p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id.</p>
125
+ <p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code>certificate_id</code>.</p>
125
126
  </div>
126
127
  </div>
127
128
  </section>
@@ -131,7 +132,7 @@
131
132
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
132
133
  <aside class="tsd-sources">
133
134
  <ul>
134
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1405">types.ts:1405</a></li>
135
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1492">datatypes.ts:1492</a></li>
135
136
  </ul>
136
137
  </aside>
137
138
  <div class="tsd-comment tsd-typography">
@@ -140,43 +141,13 @@
140
141
  </div>
141
142
  </div>
142
143
  </section>
143
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
144
- <a name="http_endpoint_configuration_id" class="tsd-anchor"></a>
145
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> http_<wbr>endpoint_<wbr>configuration_<wbr>id</h3>
146
- <div class="tsd-signature tsd-kind-icon">http_<wbr>endpoint_<wbr>configuration_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
147
- <aside class="tsd-sources">
148
- <ul>
149
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1409">types.ts:1409</a></li>
150
- </ul>
151
- </aside>
152
- <div class="tsd-comment tsd-typography">
153
- <div class="lead">
154
- <p>ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p>
155
- </div>
156
- </div>
157
- </section>
158
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
159
- <a name="https_endpoint_configuration_id" class="tsd-anchor"></a>
160
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> https_<wbr>endpoint_<wbr>configuration_<wbr>id</h3>
161
- <div class="tsd-signature tsd-kind-icon">https_<wbr>endpoint_<wbr>configuration_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
162
- <aside class="tsd-sources">
163
- <ul>
164
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1411">types.ts:1411</a></li>
165
- </ul>
166
- </aside>
167
- <div class="tsd-comment tsd-typography">
168
- <div class="lead">
169
- <p>ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p>
170
- </div>
171
- </div>
172
- </section>
173
144
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
174
145
  <a name="metadata" class="tsd-anchor"></a>
175
146
  <h3>metadata</h3>
176
147
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
177
148
  <aside class="tsd-sources">
178
149
  <ul>
179
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1407">types.ts:1407</a></li>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1494">datatypes.ts:1494</a></li>
180
151
  </ul>
181
152
  </aside>
182
153
  <div class="tsd-comment tsd-typography">
@@ -191,7 +162,7 @@
191
162
  <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
192
163
  <aside class="tsd-sources">
193
164
  <ul>
194
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1401">types.ts:1401</a></li>
165
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1488">datatypes.ts:1488</a></li>
195
166
  </ul>
196
167
  </aside>
197
168
  <div class="tsd-comment tsd-typography">
@@ -206,7 +177,7 @@
206
177
  <div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
207
178
  <aside class="tsd-sources">
208
179
  <ul>
209
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1403">types.ts:1403</a></li>
180
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1490">datatypes.ts:1490</a></li>
210
181
  </ul>
211
182
  </aside>
212
183
  <div class="tsd-comment tsd-typography">
@@ -221,7 +192,16 @@
221
192
  <nav class="tsd-navigation primary">
222
193
  <ul>
223
194
  <li class=" ">
224
- <a href="../modules.html">Exports</a>
195
+ <a href="../modules.html">Modules</a>
196
+ </li>
197
+ <li class=" tsd-kind-module">
198
+ <a href="../modules/client.html">client</a>
199
+ </li>
200
+ <li class="current tsd-kind-module">
201
+ <a href="../modules/datatypes.html">datatypes</a>
202
+ </li>
203
+ <li class=" tsd-kind-module">
204
+ <a href="../modules/services.html">services</a>
225
205
  </li>
226
206
  </ul>
227
207
  </nav>
@@ -229,32 +209,26 @@
229
209
  <ul class="before-current">
230
210
  </ul>
231
211
  <ul class="current">
232
- <li class="current tsd-kind-interface">
233
- <a href="reserveddomaincreate.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Create</a>
212
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
213
+ <a href="datatypes.ReservedDomainCreate.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>Create</a>
234
214
  <ul>
235
215
  <li class=" tsd-kind-property tsd-parent-kind-interface">
236
- <a href="reserveddomaincreate.html#certificate_id" class="tsd-kind-icon">certificate_<wbr>id</a>
237
- </li>
238
- <li class=" tsd-kind-property tsd-parent-kind-interface">
239
- <a href="reserveddomaincreate.html#certificate_management_policy" class="tsd-kind-icon">certificate_<wbr>management_<wbr>policy</a>
216
+ <a href="datatypes.ReservedDomainCreate.html#certificateId" class="tsd-kind-icon">certificate<wbr>Id</a>
240
217
  </li>
241
218
  <li class=" tsd-kind-property tsd-parent-kind-interface">
242
- <a href="reserveddomaincreate.html#description" class="tsd-kind-icon">description</a>
219
+ <a href="datatypes.ReservedDomainCreate.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a>
243
220
  </li>
244
221
  <li class=" tsd-kind-property tsd-parent-kind-interface">
245
- <a href="reserveddomaincreate.html#http_endpoint_configuration_id" class="tsd-kind-icon">http_<wbr>endpoint_<wbr>configuration_<wbr>id</a>
222
+ <a href="datatypes.ReservedDomainCreate.html#description" class="tsd-kind-icon">description</a>
246
223
  </li>
247
224
  <li class=" tsd-kind-property tsd-parent-kind-interface">
248
- <a href="reserveddomaincreate.html#https_endpoint_configuration_id" class="tsd-kind-icon">https_<wbr>endpoint_<wbr>configuration_<wbr>id</a>
225
+ <a href="datatypes.ReservedDomainCreate.html#metadata" class="tsd-kind-icon">metadata</a>
249
226
  </li>
250
227
  <li class=" tsd-kind-property tsd-parent-kind-interface">
251
- <a href="reserveddomaincreate.html#metadata" class="tsd-kind-icon">metadata</a>
228
+ <a href="datatypes.ReservedDomainCreate.html#name" class="tsd-kind-icon">name</a>
252
229
  </li>
253
230
  <li class=" tsd-kind-property tsd-parent-kind-interface">
254
- <a href="reserveddomaincreate.html#name" class="tsd-kind-icon">name</a>
255
- </li>
256
- <li class=" tsd-kind-property tsd-parent-kind-interface">
257
- <a href="reserveddomaincreate.html#region" class="tsd-kind-icon">region</a>
231
+ <a href="datatypes.ReservedDomainCreate.html#region" class="tsd-kind-icon">region</a>
258
232
  </li>
259
233
  </ul>
260
234
  </li>
@@ -270,11 +244,11 @@
270
244
  <h2>Legend</h2>
271
245
  <div class="tsd-legend-group">
272
246
  <ul class="tsd-legend">
273
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
274
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
247
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
248
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
275
249
  </ul>
276
250
  <ul class="tsd-legend">
277
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
251
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
278
252
  </ul>
279
253
  </div>
280
254
  </div>