@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/{tlsedgeupdate.html → datatypes.HTTPSEdgeUpdate.html} RENAMED
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta charset="utf-8">
5
5
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>TLSEdgeUpdate | @ngrok/ngrok-api</title>
6
+ <title>HTTPSEdgeUpdate | @ngrok/ngrok-api</title>
7
7
  <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
8
  <meta name="viewport" content="width=device-width, initial-scale=1">
9
9
  <link rel="stylesheet" href="../assets/css/main.css">
@@ -55,10 +55,13 @@
55
55
  <a href="../modules.html">@ngrok/ngrok-api</a>
56
56
  </li>
57
57
  <li>
58
- <a href="tlsedgeupdate.html">TLSEdgeUpdate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.HTTPSEdgeUpdate.html">HTTPSEdgeUpdate</a>
59
62
  </li>
60
63
  </ul>
61
- <h1>Interface TLSEdgeUpdate</h1>
64
+ <h1>Interface HTTPSEdgeUpdate</h1>
62
65
  </div>
63
66
  </div>
64
67
  </header>
@@ -69,7 +72,7 @@
69
72
  <h3>Hierarchy</h3>
70
73
  <ul class="tsd-hierarchy">
71
74
  <li>
72
- <span class="target">TLSEdgeUpdate</span>
75
+ <span class="target">HTTPSEdgeUpdate</span>
73
76
  </li>
74
77
  </ul>
75
78
  </section>
@@ -80,12 +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="tlsedgeupdate.html#description" class="tsd-kind-icon">description</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedgeupdate.html#id" class="tsd-kind-icon">id</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedgeupdate.html#ip_restriction" class="tsd-kind-icon">ip_<wbr>restriction</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedgeupdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedgeupdate.html#mutual_tls" class="tsd-kind-icon">mutual_<wbr>tls</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="tlsedgeupdate.html#tls_termination" class="tsd-kind-icon">tls_<wbr>termination</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeUpdate.html#description" class="tsd-kind-icon">description</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeUpdate.html#hostports" class="tsd-kind-icon">hostports</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeUpdate.html#id" class="tsd-kind-icon">id</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeUpdate.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeUpdate.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a></li>
89
92
  </ul>
90
93
  </section>
91
94
  </div>
@@ -99,39 +102,44 @@
99
102
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
103
  <aside class="tsd-sources">
101
104
  <ul>
102
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L795">types.ts:795</a></li>
105
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L835">datatypes.ts:835</a></li>
103
106
  </ul>
104
107
  </aside>
105
108
  <div class="tsd-comment tsd-typography">
106
109
  <div class="lead">
107
- <p>human-readable description of what this edge will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p>
110
+ <p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
108
111
  </div>
109
112
  </div>
110
113
  </section>
111
114
  <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
+ <a name="hostports" class="tsd-anchor"></a>
116
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> hostports</h3>
117
+ <div class="tsd-signature tsd-kind-icon">hostports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
115
118
  <aside class="tsd-sources">
116
119
  <ul>
117
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L793">types.ts:793</a></li>
120
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L839">datatypes.ts:839</a></li>
118
121
  </ul>
119
122
  </aside>
120
123
  <div class="tsd-comment tsd-typography">
121
124
  <div class="lead">
122
- <p>unique identifier of this edge</p>
125
+ <p>hostports served by this edge</p>
123
126
  </div>
124
127
  </div>
125
128
  </section>
126
129
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
127
- <a name="ip_restriction" class="tsd-anchor"></a>
128
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip_<wbr>restriction</h3>
129
- <div class="tsd-signature tsd-kind-icon">ip_<wbr>restriction<span class="tsd-signature-symbol">:</span> <a href="endpointippolicymutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicyMutate</a></div>
130
+ <a name="id" class="tsd-anchor"></a>
131
+ <h3>id</h3>
132
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130
133
  <aside class="tsd-sources">
131
134
  <ul>
132
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L798">types.ts:798</a></li>
135
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L833">datatypes.ts:833</a></li>
133
136
  </ul>
134
137
  </aside>
138
+ <div class="tsd-comment tsd-typography">
139
+ <div class="lead">
140
+ <p>unique identifier of this edge</p>
141
+ </div>
142
+ </div>
135
143
  </section>
136
144
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
137
145
  <a name="metadata" class="tsd-anchor"></a>
@@ -139,32 +147,37 @@
139
147
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
140
148
  <aside class="tsd-sources">
141
149
  <ul>
142
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L797">types.ts:797</a></li>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L837">datatypes.ts:837</a></li>
143
151
  </ul>
144
152
  </aside>
145
153
  <div class="tsd-comment tsd-typography">
146
154
  <div class="lead">
147
- <p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
155
+ <p>arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.</p>
148
156
  </div>
149
157
  </div>
150
158
  </section>
151
159
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
152
- <a name="mutual_tls" class="tsd-anchor"></a>
153
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> mutual_<wbr>tls</h3>
154
- <div class="tsd-signature tsd-kind-icon">mutual_<wbr>tls<span class="tsd-signature-symbol">:</span> <a href="endpointmutualtlsmutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLSMutate</a></div>
160
+ <a name="mutualTls" class="tsd-anchor"></a>
161
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> mutual<wbr>Tls</h3>
162
+ <div class="tsd-signature tsd-kind-icon">mutual<wbr>Tls<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointMutualTLSMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLSMutate</a></div>
155
163
  <aside class="tsd-sources">
156
164
  <ul>
157
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L799">types.ts:799</a></li>
165
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L841">datatypes.ts:841</a></li>
158
166
  </ul>
159
167
  </aside>
168
+ <div class="tsd-comment tsd-typography">
169
+ <div class="lead">
170
+ <p>edge modules</p>
171
+ </div>
172
+ </div>
160
173
  </section>
161
174
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
162
- <a name="tls_termination" class="tsd-anchor"></a>
163
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> tls_<wbr>termination</h3>
164
- <div class="tsd-signature tsd-kind-icon">tls_<wbr>termination<span class="tsd-signature-symbol">:</span> <a href="endpointtlstermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</a></div>
175
+ <a name="tlsTermination" class="tsd-anchor"></a>
176
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> tls<wbr>Termination</h3>
177
+ <div class="tsd-signature tsd-kind-icon">tls<wbr>Termination<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTerminationAtEdge.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTerminationAtEdge</a></div>
165
178
  <aside class="tsd-sources">
166
179
  <ul>
167
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L800">types.ts:800</a></li>
180
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L842">datatypes.ts:842</a></li>
168
181
  </ul>
169
182
  </aside>
170
183
  </section>
@@ -174,7 +187,16 @@
174
187
  <nav class="tsd-navigation primary">
175
188
  <ul>
176
189
  <li class=" ">
177
- <a href="../modules.html">Exports</a>
190
+ <a href="../modules.html">Modules</a>
191
+ </li>
192
+ <li class=" tsd-kind-module">
193
+ <a href="../modules/client.html">client</a>
194
+ </li>
195
+ <li class="current tsd-kind-module">
196
+ <a href="../modules/datatypes.html">datatypes</a>
197
+ </li>
198
+ <li class=" tsd-kind-module">
199
+ <a href="../modules/services.html">services</a>
178
200
  </li>
179
201
  </ul>
180
202
  </nav>
@@ -182,26 +204,26 @@
182
204
  <ul class="before-current">
183
205
  </ul>
184
206
  <ul class="current">
185
- <li class="current tsd-kind-interface">
186
- <a href="tlsedgeupdate.html" class="tsd-kind-icon">TLSEdge<wbr>Update</a>
207
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
208
+ <a href="datatypes.HTTPSEdgeUpdate.html" class="tsd-kind-icon">HTTPSEdge<wbr>Update</a>
187
209
  <ul>
188
210
  <li class=" tsd-kind-property tsd-parent-kind-interface">
189
- <a href="tlsedgeupdate.html#description" class="tsd-kind-icon">description</a>
211
+ <a href="datatypes.HTTPSEdgeUpdate.html#description" class="tsd-kind-icon">description</a>
190
212
  </li>
191
213
  <li class=" tsd-kind-property tsd-parent-kind-interface">
192
- <a href="tlsedgeupdate.html#id" class="tsd-kind-icon">id</a>
214
+ <a href="datatypes.HTTPSEdgeUpdate.html#hostports" class="tsd-kind-icon">hostports</a>
193
215
  </li>
194
216
  <li class=" tsd-kind-property tsd-parent-kind-interface">
195
- <a href="tlsedgeupdate.html#ip_restriction" class="tsd-kind-icon">ip_<wbr>restriction</a>
217
+ <a href="datatypes.HTTPSEdgeUpdate.html#id" class="tsd-kind-icon">id</a>
196
218
  </li>
197
219
  <li class=" tsd-kind-property tsd-parent-kind-interface">
198
- <a href="tlsedgeupdate.html#metadata" class="tsd-kind-icon">metadata</a>
220
+ <a href="datatypes.HTTPSEdgeUpdate.html#metadata" class="tsd-kind-icon">metadata</a>
199
221
  </li>
200
222
  <li class=" tsd-kind-property tsd-parent-kind-interface">
201
- <a href="tlsedgeupdate.html#mutual_tls" class="tsd-kind-icon">mutual_<wbr>tls</a>
223
+ <a href="datatypes.HTTPSEdgeUpdate.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a>
202
224
  </li>
203
225
  <li class=" tsd-kind-property tsd-parent-kind-interface">
204
- <a href="tlsedgeupdate.html#tls_termination" class="tsd-kind-icon">tls_<wbr>termination</a>
226
+ <a href="datatypes.HTTPSEdgeUpdate.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a>
205
227
  </li>
206
228
  </ul>
207
229
  </li>
@@ -217,11 +239,11 @@
217
239
  <h2>Legend</h2>
218
240
  <div class="tsd-legend-group">
219
241
  <ul class="tsd-legend">
220
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
221
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
242
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
243
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
222
244
  </ul>
223
245
  <ul class="tsd-legend">
224
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
246
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
225
247
  </ul>
226
248
  </div>
227
249
  </div>
package/docs/interfaces/{ippolicy.html → datatypes.IPPolicy.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="ippolicy.html">IPPolicy</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.IPPolicy.html">IPPolicy</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface IPPolicy</h1>
@@ -80,12 +83,11 @@
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="ippolicy.html#action" class="tsd-kind-icon">action</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicy.html#created_at" class="tsd-kind-icon">created_<wbr>at</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicy.html#description" class="tsd-kind-icon">description</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicy.html#id" class="tsd-kind-icon">id</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicy.html#metadata" class="tsd-kind-icon">metadata</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicy.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicy.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicy.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicy.html#id" class="tsd-kind-icon">id</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicy.html#metadata" class="tsd-kind-icon">metadata</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicy.html#uri" class="tsd-kind-icon">uri</a></li>
89
91
  </ul>
90
92
  </section>
91
93
  </div>
@@ -94,27 +96,12 @@
94
96
  <section class="tsd-panel-group tsd-member-group ">
95
97
  <h2>Properties</h2>
96
98
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
97
- <a name="action" class="tsd-anchor"></a>
98
- <h3>action</h3>
99
- <div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
+ <a name="createdAt" class="tsd-anchor"></a>
100
+ <h3>created<wbr>At</h3>
101
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
102
  <aside class="tsd-sources">
101
103
  <ul>
102
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1127">types.ts:1127</a></li>
103
- </ul>
104
- </aside>
105
- <div class="tsd-comment tsd-typography">
106
- <div class="lead">
107
- <p>the IP policy action. Supported values are allow or deny</p>
108
- </div>
109
- </div>
110
- </section>
111
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
112
- <a name="created_at" class="tsd-anchor"></a>
113
- <h3>created_<wbr>at</h3>
114
- <div class="tsd-signature tsd-kind-icon">created_<wbr>at<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/5488ad8/src/types.ts#L1121">types.ts:1121</a></li>
104
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1323">datatypes.ts:1323</a></li>
118
105
  </ul>
119
106
  </aside>
120
107
  <div class="tsd-comment tsd-typography">
@@ -129,7 +116,7 @@
129
116
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130
117
  <aside class="tsd-sources">
131
118
  <ul>
132
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1123">types.ts:1123</a></li>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1325">datatypes.ts:1325</a></li>
133
120
  </ul>
134
121
  </aside>
135
122
  <div class="tsd-comment tsd-typography">
@@ -144,7 +131,7 @@
144
131
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
145
132
  <aside class="tsd-sources">
146
133
  <ul>
147
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1117">types.ts:1117</a></li>
134
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1319">datatypes.ts:1319</a></li>
148
135
  </ul>
149
136
  </aside>
150
137
  <div class="tsd-comment tsd-typography">
@@ -159,7 +146,7 @@
159
146
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
160
147
  <aside class="tsd-sources">
161
148
  <ul>
162
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1125">types.ts:1125</a></li>
149
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1327">datatypes.ts:1327</a></li>
163
150
  </ul>
164
151
  </aside>
165
152
  <div class="tsd-comment tsd-typography">
@@ -174,7 +161,7 @@
174
161
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
175
162
  <aside class="tsd-sources">
176
163
  <ul>
177
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1119">types.ts:1119</a></li>
164
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1321">datatypes.ts:1321</a></li>
178
165
  </ul>
179
166
  </aside>
180
167
  <div class="tsd-comment tsd-typography">
@@ -189,7 +176,16 @@
189
176
  <nav class="tsd-navigation primary">
190
177
  <ul>
191
178
  <li class=" ">
192
- <a href="../modules.html">Exports</a>
179
+ <a href="../modules.html">Modules</a>
180
+ </li>
181
+ <li class=" tsd-kind-module">
182
+ <a href="../modules/client.html">client</a>
183
+ </li>
184
+ <li class="current tsd-kind-module">
185
+ <a href="../modules/datatypes.html">datatypes</a>
186
+ </li>
187
+ <li class=" tsd-kind-module">
188
+ <a href="../modules/services.html">services</a>
193
189
  </li>
194
190
  </ul>
195
191
  </nav>
@@ -197,26 +193,23 @@
197
193
  <ul class="before-current">
198
194
  </ul>
199
195
  <ul class="current">
200
- <li class="current tsd-kind-interface">
201
- <a href="ippolicy.html" class="tsd-kind-icon">IPPolicy</a>
196
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
197
+ <a href="datatypes.IPPolicy.html" class="tsd-kind-icon">IPPolicy</a>
202
198
  <ul>
203
199
  <li class=" tsd-kind-property tsd-parent-kind-interface">
204
- <a href="ippolicy.html#action" class="tsd-kind-icon">action</a>
200
+ <a href="datatypes.IPPolicy.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
205
201
  </li>
206
202
  <li class=" tsd-kind-property tsd-parent-kind-interface">
207
- <a href="ippolicy.html#created_at" class="tsd-kind-icon">created_<wbr>at</a>
203
+ <a href="datatypes.IPPolicy.html#description" class="tsd-kind-icon">description</a>
208
204
  </li>
209
205
  <li class=" tsd-kind-property tsd-parent-kind-interface">
210
- <a href="ippolicy.html#description" class="tsd-kind-icon">description</a>
206
+ <a href="datatypes.IPPolicy.html#id" class="tsd-kind-icon">id</a>
211
207
  </li>
212
208
  <li class=" tsd-kind-property tsd-parent-kind-interface">
213
- <a href="ippolicy.html#id" class="tsd-kind-icon">id</a>
209
+ <a href="datatypes.IPPolicy.html#metadata" class="tsd-kind-icon">metadata</a>
214
210
  </li>
215
211
  <li class=" tsd-kind-property tsd-parent-kind-interface">
216
- <a href="ippolicy.html#metadata" class="tsd-kind-icon">metadata</a>
217
- </li>
218
- <li class=" tsd-kind-property tsd-parent-kind-interface">
219
- <a href="ippolicy.html#uri" class="tsd-kind-icon">uri</a>
212
+ <a href="datatypes.IPPolicy.html#uri" class="tsd-kind-icon">uri</a>
220
213
  </li>
221
214
  </ul>
222
215
  </li>
@@ -232,11 +225,11 @@
232
225
  <h2>Legend</h2>
233
226
  <div class="tsd-legend-group">
234
227
  <ul class="tsd-legend">
235
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
236
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
228
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
229
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
237
230
  </ul>
238
231
  <ul class="tsd-legend">
239
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
232
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
240
233
  </ul>
241
234
  </div>
242
235
  </div>
package/docs/interfaces/{ippolicycreate.html → datatypes.IPPolicyCreate.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="ippolicycreate.html">IPPolicyCreate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.IPPolicyCreate.html">IPPolicyCreate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface IPPolicyCreate</h1>
@@ -80,9 +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="ippolicycreate.html#action" class="tsd-kind-icon">action</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicycreate.html#description" class="tsd-kind-icon">description</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicycreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyCreate.html#description" class="tsd-kind-icon">description</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
86
88
  </ul>
87
89
  </section>
88
90
  </div>
@@ -90,28 +92,13 @@
90
92
  </section>
91
93
  <section class="tsd-panel-group tsd-member-group ">
92
94
  <h2>Properties</h2>
93
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
94
- <a name="action" class="tsd-anchor"></a>
95
- <h3>action</h3>
96
- <div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
97
- <aside class="tsd-sources">
98
- <ul>
99
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1104">types.ts:1104</a></li>
100
- </ul>
101
- </aside>
102
- <div class="tsd-comment tsd-typography">
103
- <div class="lead">
104
- <p>the IP policy action. Supported values are allow or deny</p>
105
- </div>
106
- </div>
107
- </section>
108
95
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
109
96
  <a name="description" class="tsd-anchor"></a>
110
97
  <h3>description</h3>
111
98
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
112
99
  <aside class="tsd-sources">
113
100
  <ul>
114
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1100">types.ts:1100</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1304">datatypes.ts:1304</a></li>
115
102
  </ul>
116
103
  </aside>
117
104
  <div class="tsd-comment tsd-typography">
@@ -126,7 +113,7 @@
126
113
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
127
114
  <aside class="tsd-sources">
128
115
  <ul>
129
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1102">types.ts:1102</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1306">datatypes.ts:1306</a></li>
130
117
  </ul>
131
118
  </aside>
132
119
  <div class="tsd-comment tsd-typography">
@@ -141,7 +128,16 @@
141
128
  <nav class="tsd-navigation primary">
142
129
  <ul>
143
130
  <li class=" ">
144
- <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>
145
141
  </li>
146
142
  </ul>
147
143
  </nav>
@@ -149,17 +145,14 @@
149
145
  <ul class="before-current">
150
146
  </ul>
151
147
  <ul class="current">
152
- <li class="current tsd-kind-interface">
153
- <a href="ippolicycreate.html" class="tsd-kind-icon">IPPolicy<wbr>Create</a>
148
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
149
+ <a href="datatypes.IPPolicyCreate.html" class="tsd-kind-icon">IPPolicy<wbr>Create</a>
154
150
  <ul>
155
151
  <li class=" tsd-kind-property tsd-parent-kind-interface">
156
- <a href="ippolicycreate.html#action" class="tsd-kind-icon">action</a>
152
+ <a href="datatypes.IPPolicyCreate.html#description" class="tsd-kind-icon">description</a>
157
153
  </li>
158
154
  <li class=" tsd-kind-property tsd-parent-kind-interface">
159
- <a href="ippolicycreate.html#description" class="tsd-kind-icon">description</a>
160
- </li>
161
- <li class=" tsd-kind-property tsd-parent-kind-interface">
162
- <a href="ippolicycreate.html#metadata" class="tsd-kind-icon">metadata</a>
155
+ <a href="datatypes.IPPolicyCreate.html#metadata" class="tsd-kind-icon">metadata</a>
163
156
  </li>
164
157
  </ul>
165
158
  </li>
@@ -175,11 +168,11 @@
175
168
  <h2>Legend</h2>
176
169
  <div class="tsd-legend-group">
177
170
  <ul class="tsd-legend">
178
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
179
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
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>
180
173
  </ul>
181
174
  <ul class="tsd-legend">
182
- <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>
183
176
  </ul>
184
177
  </div>
185
178
  </div>