@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/datatypes.ReservedAddrUpdate.html ADDED
@@ -0,0 +1,200 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>ReservedAddrUpdate | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.ReservedAddrUpdate.html">ReservedAddrUpdate</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface ReservedAddrUpdate</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">ReservedAddrUpdate</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedAddrUpdate.html#description" class="tsd-kind-icon">description</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedAddrUpdate.html#id" class="tsd-kind-icon">id</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedAddrUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
89
+ </ul>
90
+ </section>
91
+ </div>
92
+ </section>
93
+ </section>
94
+ <section class="tsd-panel-group tsd-member-group ">
95
+ <h2>Properties</h2>
96
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
97
+ <a name="description" class="tsd-anchor"></a>
98
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
99
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
+ <aside class="tsd-sources">
101
+ <ul>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1455">datatypes.ts:1455</a></li>
103
+ </ul>
104
+ </aside>
105
+ <div class="tsd-comment tsd-typography">
106
+ <div class="lead">
107
+ <p>human-readable description of what this reserved address will be used for</p>
108
+ </div>
109
+ </div>
110
+ </section>
111
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
112
+ <a name="id" class="tsd-anchor"></a>
113
+ <h3>id</h3>
114
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
115
+ <aside class="tsd-sources">
116
+ <ul>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1453">datatypes.ts:1453</a></li>
118
+ </ul>
119
+ </aside>
120
+ </section>
121
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
122
+ <a name="metadata" class="tsd-anchor"></a>
123
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
124
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
125
+ <aside class="tsd-sources">
126
+ <ul>
127
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1457">datatypes.ts:1457</a></li>
128
+ </ul>
129
+ </aside>
130
+ <div class="tsd-comment tsd-typography">
131
+ <div class="lead">
132
+ <p>arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.</p>
133
+ </div>
134
+ </div>
135
+ </section>
136
+ </section>
137
+ </div>
138
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
139
+ <nav class="tsd-navigation primary">
140
+ <ul>
141
+ <li class=" ">
142
+ <a href="../modules.html">Modules</a>
143
+ </li>
144
+ <li class=" tsd-kind-module">
145
+ <a href="../modules/client.html">client</a>
146
+ </li>
147
+ <li class="current tsd-kind-module">
148
+ <a href="../modules/datatypes.html">datatypes</a>
149
+ </li>
150
+ <li class=" tsd-kind-module">
151
+ <a href="../modules/services.html">services</a>
152
+ </li>
153
+ </ul>
154
+ </nav>
155
+ <nav class="tsd-navigation secondary menu-sticky">
156
+ <ul class="before-current">
157
+ </ul>
158
+ <ul class="current">
159
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
160
+ <a href="datatypes.ReservedAddrUpdate.html" class="tsd-kind-icon">Reserved<wbr>Addr<wbr>Update</a>
161
+ <ul>
162
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
163
+ <a href="datatypes.ReservedAddrUpdate.html#description" class="tsd-kind-icon">description</a>
164
+ </li>
165
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
166
+ <a href="datatypes.ReservedAddrUpdate.html#id" class="tsd-kind-icon">id</a>
167
+ </li>
168
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
169
+ <a href="datatypes.ReservedAddrUpdate.html#metadata" class="tsd-kind-icon">metadata</a>
170
+ </li>
171
+ </ul>
172
+ </li>
173
+ </ul>
174
+ <ul class="after-current">
175
+ </ul>
176
+ </nav>
177
+ </div>
178
+ </div>
179
+ </div>
180
+ <footer class="with-border-bottom">
181
+ <div class="container">
182
+ <h2>Legend</h2>
183
+ <div class="tsd-legend-group">
184
+ <ul class="tsd-legend">
185
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
186
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
187
+ </ul>
188
+ <ul class="tsd-legend">
189
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
190
+ </ul>
191
+ </div>
192
+ </div>
193
+ </footer>
194
+ <div class="container tsd-generator">
195
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
196
+ </div>
197
+ <div class="overlay"></div>
198
+ <script src="../assets/js/main.js"></script>
199
+ </body>
200
+ </html>
package/docs/interfaces/{reserveddomain.html → datatypes.ReservedDomain.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="reserveddomain.html">ReservedDomain</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.ReservedDomain.html">ReservedDomain</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface ReservedDomain</h1>
@@ -80,19 +83,18 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomain.html#certificate" class="tsd-kind-icon">certificate</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomain.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="reserveddomain.html#certificate_management_status" class="tsd-kind-icon">certificate_<wbr>management_<wbr>status</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomain.html#cname_target" class="tsd-kind-icon">cname_<wbr>target</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomain.html#created_at" class="tsd-kind-icon">created_<wbr>at</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomain.html#description" class="tsd-kind-icon">description</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomain.html#domain" class="tsd-kind-icon">domain</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomain.html#http_endpoint_configuration" class="tsd-kind-icon">http_<wbr>endpoint_<wbr>configuration</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomain.html#https_endpoint_configuration" class="tsd-kind-icon">https_<wbr>endpoint_<wbr>configuration</a></li>
92
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomain.html#id" class="tsd-kind-icon">id</a></li>
93
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomain.html#metadata" class="tsd-kind-icon">metadata</a></li>
94
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomain.html#region" class="tsd-kind-icon">region</a></li>
95
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="reserveddomain.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#acmeChallengeCnameTarget" class="tsd-kind-icon">acme<wbr>Challenge<wbr>Cname<wbr>Target</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#certificate" class="tsd-kind-icon">certificate</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#certificateManagementStatus" class="tsd-kind-icon">certificate<wbr>Management<wbr>Status</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#cnameTarget" class="tsd-kind-icon">cname<wbr>Target</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#description" class="tsd-kind-icon">description</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#domain" class="tsd-kind-icon">domain</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#id" class="tsd-kind-icon">id</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#metadata" class="tsd-kind-icon">metadata</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#region" class="tsd-kind-icon">region</a></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomain.html#uri" class="tsd-kind-icon">uri</a></li>
96
98
  </ul>
97
99
  </section>
98
100
  </div>
@@ -100,13 +102,28 @@
100
102
  </section>
101
103
  <section class="tsd-panel-group tsd-member-group ">
102
104
  <h2>Properties</h2>
105
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
106
+ <a name="acmeChallengeCnameTarget" class="tsd-anchor"></a>
107
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> acme<wbr>Challenge<wbr>Cname<wbr>Target</h3>
108
+ <div class="tsd-signature tsd-kind-icon">acme<wbr>Challenge<wbr>Cname<wbr>Target<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
109
+ <aside class="tsd-sources">
110
+ <ul>
111
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1537">datatypes.ts:1537</a></li>
112
+ </ul>
113
+ </aside>
114
+ <div class="tsd-comment tsd-typography">
115
+ <div class="lead">
116
+ <p>DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.</p>
117
+ </div>
118
+ </div>
119
+ </section>
103
120
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
104
121
  <a name="certificate" class="tsd-anchor"></a>
105
122
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate</h3>
106
- <div class="tsd-signature tsd-kind-icon">certificate<span class="tsd-signature-symbol">:</span> <a href="ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
123
+ <div class="tsd-signature tsd-kind-icon">certificate<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
107
124
  <aside class="tsd-sources">
108
125
  <ul>
109
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1456">types.ts:1456</a></li>
126
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1531">datatypes.ts:1531</a></li>
110
127
  </ul>
111
128
  </aside>
112
129
  <div class="tsd-comment tsd-typography">
@@ -116,12 +133,12 @@
116
133
  </div>
117
134
  </section>
118
135
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
119
- <a name="certificate_management_policy" class="tsd-anchor"></a>
120
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate_<wbr>management_<wbr>policy</h3>
121
- <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>
136
+ <a name="certificateManagementPolicy" class="tsd-anchor"></a>
137
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate<wbr>Management<wbr>Policy</h3>
138
+ <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>
122
139
  <aside class="tsd-sources">
123
140
  <ul>
124
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1458">types.ts:1458</a></li>
141
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1533">datatypes.ts:1533</a></li>
125
142
  </ul>
126
143
  </aside>
127
144
  <div class="tsd-comment tsd-typography">
@@ -131,12 +148,12 @@
131
148
  </div>
132
149
  </section>
133
150
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
134
- <a name="certificate_management_status" class="tsd-anchor"></a>
135
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate_<wbr>management_<wbr>status</h3>
136
- <div class="tsd-signature tsd-kind-icon">certificate_<wbr>management_<wbr>status<span class="tsd-signature-symbol">:</span> <a href="reserveddomaincertstatus.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomainCertStatus</a></div>
151
+ <a name="certificateManagementStatus" class="tsd-anchor"></a>
152
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate<wbr>Management<wbr>Status</h3>
153
+ <div class="tsd-signature tsd-kind-icon">certificate<wbr>Management<wbr>Status<span class="tsd-signature-symbol">:</span> <a href="datatypes.ReservedDomainCertStatus.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomainCertStatus</a></div>
137
154
  <aside class="tsd-sources">
138
155
  <ul>
139
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1460">types.ts:1460</a></li>
156
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1535">datatypes.ts:1535</a></li>
140
157
  </ul>
141
158
  </aside>
142
159
  <div class="tsd-comment tsd-typography">
@@ -146,12 +163,12 @@
146
163
  </div>
147
164
  </section>
148
165
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
149
- <a name="cname_target" class="tsd-anchor"></a>
150
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> cname_<wbr>target</h3>
151
- <div class="tsd-signature tsd-kind-icon">cname_<wbr>target<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
166
+ <a name="cnameTarget" class="tsd-anchor"></a>
167
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> cname<wbr>Target</h3>
168
+ <div class="tsd-signature tsd-kind-icon">cname<wbr>Target<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
152
169
  <aside class="tsd-sources">
153
170
  <ul>
154
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1450">types.ts:1450</a></li>
171
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1529">datatypes.ts:1529</a></li>
155
172
  </ul>
156
173
  </aside>
157
174
  <div class="tsd-comment tsd-typography">
@@ -161,12 +178,12 @@
161
178
  </div>
162
179
  </section>
163
180
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
164
- <a name="created_at" class="tsd-anchor"></a>
165
- <h3>created_<wbr>at</h3>
166
- <div class="tsd-signature tsd-kind-icon">created_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
181
+ <a name="createdAt" class="tsd-anchor"></a>
182
+ <h3>created<wbr>At</h3>
183
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
167
184
  <aside class="tsd-sources">
168
185
  <ul>
169
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1440">types.ts:1440</a></li>
186
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1519">datatypes.ts:1519</a></li>
170
187
  </ul>
171
188
  </aside>
172
189
  <div class="tsd-comment tsd-typography">
@@ -181,7 +198,7 @@
181
198
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
182
199
  <aside class="tsd-sources">
183
200
  <ul>
184
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1442">types.ts:1442</a></li>
201
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1521">datatypes.ts:1521</a></li>
185
202
  </ul>
186
203
  </aside>
187
204
  <div class="tsd-comment tsd-typography">
@@ -196,7 +213,7 @@
196
213
  <div class="tsd-signature tsd-kind-icon">domain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
197
214
  <aside class="tsd-sources">
198
215
  <ul>
199
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1446">types.ts:1446</a></li>
216
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1525">datatypes.ts:1525</a></li>
200
217
  </ul>
201
218
  </aside>
202
219
  <div class="tsd-comment tsd-typography">
@@ -205,43 +222,13 @@
205
222
  </div>
206
223
  </div>
207
224
  </section>
208
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
209
- <a name="http_endpoint_configuration" class="tsd-anchor"></a>
210
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> http_<wbr>endpoint_<wbr>configuration</h3>
211
- <div class="tsd-signature tsd-kind-icon">http_<wbr>endpoint_<wbr>configuration<span class="tsd-signature-symbol">:</span> <a href="ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
212
- <aside class="tsd-sources">
213
- <ul>
214
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1452">types.ts:1452</a></li>
215
- </ul>
216
- </aside>
217
- <div class="tsd-comment tsd-typography">
218
- <div class="lead">
219
- <p>object referencing the endpoint configuration applied to http traffic on this domain</p>
220
- </div>
221
- </div>
222
- </section>
223
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
224
- <a name="https_endpoint_configuration" class="tsd-anchor"></a>
225
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> https_<wbr>endpoint_<wbr>configuration</h3>
226
- <div class="tsd-signature tsd-kind-icon">https_<wbr>endpoint_<wbr>configuration<span class="tsd-signature-symbol">:</span> <a href="ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
227
- <aside class="tsd-sources">
228
- <ul>
229
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1454">types.ts:1454</a></li>
230
- </ul>
231
- </aside>
232
- <div class="tsd-comment tsd-typography">
233
- <div class="lead">
234
- <p>object referencing the endpoint configuration applied to https traffic on this domain</p>
235
- </div>
236
- </div>
237
- </section>
238
225
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
239
226
  <a name="id" class="tsd-anchor"></a>
240
227
  <h3>id</h3>
241
228
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
242
229
  <aside class="tsd-sources">
243
230
  <ul>
244
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1436">types.ts:1436</a></li>
231
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1515">datatypes.ts:1515</a></li>
245
232
  </ul>
246
233
  </aside>
247
234
  <div class="tsd-comment tsd-typography">
@@ -256,7 +243,7 @@
256
243
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
257
244
  <aside class="tsd-sources">
258
245
  <ul>
259
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1444">types.ts:1444</a></li>
246
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1523">datatypes.ts:1523</a></li>
260
247
  </ul>
261
248
  </aside>
262
249
  <div class="tsd-comment tsd-typography">
@@ -271,7 +258,7 @@
271
258
  <div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
272
259
  <aside class="tsd-sources">
273
260
  <ul>
274
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1448">types.ts:1448</a></li>
261
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1527">datatypes.ts:1527</a></li>
275
262
  </ul>
276
263
  </aside>
277
264
  <div class="tsd-comment tsd-typography">
@@ -286,7 +273,7 @@
286
273
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
287
274
  <aside class="tsd-sources">
288
275
  <ul>
289
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1438">types.ts:1438</a></li>
276
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1517">datatypes.ts:1517</a></li>
290
277
  </ul>
291
278
  </aside>
292
279
  <div class="tsd-comment tsd-typography">
@@ -301,7 +288,16 @@
301
288
  <nav class="tsd-navigation primary">
302
289
  <ul>
303
290
  <li class=" ">
304
- <a href="../modules.html">Exports</a>
291
+ <a href="../modules.html">Modules</a>
292
+ </li>
293
+ <li class=" tsd-kind-module">
294
+ <a href="../modules/client.html">client</a>
295
+ </li>
296
+ <li class="current tsd-kind-module">
297
+ <a href="../modules/datatypes.html">datatypes</a>
298
+ </li>
299
+ <li class=" tsd-kind-module">
300
+ <a href="../modules/services.html">services</a>
305
301
  </li>
306
302
  </ul>
307
303
  </nav>
@@ -309,47 +305,44 @@
309
305
  <ul class="before-current">
310
306
  </ul>
311
307
  <ul class="current">
312
- <li class="current tsd-kind-interface">
313
- <a href="reserveddomain.html" class="tsd-kind-icon">Reserved<wbr>Domain</a>
308
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
309
+ <a href="datatypes.ReservedDomain.html" class="tsd-kind-icon">Reserved<wbr>Domain</a>
314
310
  <ul>
315
311
  <li class=" tsd-kind-property tsd-parent-kind-interface">
316
- <a href="reserveddomain.html#certificate" class="tsd-kind-icon">certificate</a>
312
+ <a href="datatypes.ReservedDomain.html#acmeChallengeCnameTarget" class="tsd-kind-icon">acme<wbr>Challenge<wbr>Cname<wbr>Target</a>
317
313
  </li>
318
314
  <li class=" tsd-kind-property tsd-parent-kind-interface">
319
- <a href="reserveddomain.html#certificate_management_policy" class="tsd-kind-icon">certificate_<wbr>management_<wbr>policy</a>
315
+ <a href="datatypes.ReservedDomain.html#certificate" class="tsd-kind-icon">certificate</a>
320
316
  </li>
321
317
  <li class=" tsd-kind-property tsd-parent-kind-interface">
322
- <a href="reserveddomain.html#certificate_management_status" class="tsd-kind-icon">certificate_<wbr>management_<wbr>status</a>
318
+ <a href="datatypes.ReservedDomain.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a>
323
319
  </li>
324
320
  <li class=" tsd-kind-property tsd-parent-kind-interface">
325
- <a href="reserveddomain.html#cname_target" class="tsd-kind-icon">cname_<wbr>target</a>
321
+ <a href="datatypes.ReservedDomain.html#certificateManagementStatus" class="tsd-kind-icon">certificate<wbr>Management<wbr>Status</a>
326
322
  </li>
327
323
  <li class=" tsd-kind-property tsd-parent-kind-interface">
328
- <a href="reserveddomain.html#created_at" class="tsd-kind-icon">created_<wbr>at</a>
324
+ <a href="datatypes.ReservedDomain.html#cnameTarget" class="tsd-kind-icon">cname<wbr>Target</a>
329
325
  </li>
330
326
  <li class=" tsd-kind-property tsd-parent-kind-interface">
331
- <a href="reserveddomain.html#description" class="tsd-kind-icon">description</a>
327
+ <a href="datatypes.ReservedDomain.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
332
328
  </li>
333
329
  <li class=" tsd-kind-property tsd-parent-kind-interface">
334
- <a href="reserveddomain.html#domain" class="tsd-kind-icon">domain</a>
330
+ <a href="datatypes.ReservedDomain.html#description" class="tsd-kind-icon">description</a>
335
331
  </li>
336
332
  <li class=" tsd-kind-property tsd-parent-kind-interface">
337
- <a href="reserveddomain.html#http_endpoint_configuration" class="tsd-kind-icon">http_<wbr>endpoint_<wbr>configuration</a>
333
+ <a href="datatypes.ReservedDomain.html#domain" class="tsd-kind-icon">domain</a>
338
334
  </li>
339
335
  <li class=" tsd-kind-property tsd-parent-kind-interface">
340
- <a href="reserveddomain.html#https_endpoint_configuration" class="tsd-kind-icon">https_<wbr>endpoint_<wbr>configuration</a>
336
+ <a href="datatypes.ReservedDomain.html#id" class="tsd-kind-icon">id</a>
341
337
  </li>
342
338
  <li class=" tsd-kind-property tsd-parent-kind-interface">
343
- <a href="reserveddomain.html#id" class="tsd-kind-icon">id</a>
339
+ <a href="datatypes.ReservedDomain.html#metadata" class="tsd-kind-icon">metadata</a>
344
340
  </li>
345
341
  <li class=" tsd-kind-property tsd-parent-kind-interface">
346
- <a href="reserveddomain.html#metadata" class="tsd-kind-icon">metadata</a>
342
+ <a href="datatypes.ReservedDomain.html#region" class="tsd-kind-icon">region</a>
347
343
  </li>
348
344
  <li class=" tsd-kind-property tsd-parent-kind-interface">
349
- <a href="reserveddomain.html#region" class="tsd-kind-icon">region</a>
350
- </li>
351
- <li class=" tsd-kind-property tsd-parent-kind-interface">
352
- <a href="reserveddomain.html#uri" class="tsd-kind-icon">uri</a>
345
+ <a href="datatypes.ReservedDomain.html#uri" class="tsd-kind-icon">uri</a>
353
346
  </li>
354
347
  </ul>
355
348
  </li>
@@ -365,11 +358,11 @@
365
358
  <h2>Legend</h2>
366
359
  <div class="tsd-legend-group">
367
360
  <ul class="tsd-legend">
368
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
369
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
361
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
362
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
370
363
  </ul>
371
364
  <ul class="tsd-legend">
372
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
365
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
373
366
  </ul>
374
367
  </div>
375
368
  </div>