@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/{endpointcircuitbreaker.html → datatypes.EndpointCircuitBreaker.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="endpointcircuitbreaker.html">EndpointCircuitBreaker</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointCircuitBreaker.html">EndpointCircuitBreaker</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointCircuitBreaker</h1>
@@ -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="endpointcircuitbreaker.html#enabled" class="tsd-kind-icon">enabled</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointcircuitbreaker.html#error_threshold_percentage" class="tsd-kind-icon">error_<wbr>threshold_<wbr>percentage</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointcircuitbreaker.html#num_buckets" class="tsd-kind-icon">num_<wbr>buckets</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointcircuitbreaker.html#rolling_window" class="tsd-kind-icon">rolling_<wbr>window</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointcircuitbreaker.html#tripped_duration" class="tsd-kind-icon">tripped_<wbr>duration</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointcircuitbreaker.html#volume_threshold" class="tsd-kind-icon">volume_<wbr>threshold</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointCircuitBreaker.html#enabled" class="tsd-kind-icon">enabled</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointCircuitBreaker.html#errorThresholdPercentage" class="tsd-kind-icon">error<wbr>Threshold<wbr>Percentage</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointCircuitBreaker.html#numBuckets" class="tsd-kind-icon">num<wbr>Buckets</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointCircuitBreaker.html#rollingWindow" class="tsd-kind-icon">rolling<wbr>Window</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointCircuitBreaker.html#trippedDuration" class="tsd-kind-icon">tripped<wbr>Duration</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointCircuitBreaker.html#volumeThreshold" class="tsd-kind-icon">volume<wbr>Threshold</a></li>
89
92
  </ul>
90
93
  </section>
91
94
  </div>
@@ -99,22 +102,22 @@
99
102
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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#L568">types.ts:568</a></li>
105
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L497">datatypes.ts:497</a></li>
103
106
  </ul>
104
107
  </aside>
105
108
  <div class="tsd-comment tsd-typography">
106
109
  <div class="lead">
107
- <p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
110
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</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="error_threshold_percentage" class="tsd-anchor"></a>
113
- <h3>error_<wbr>threshold_<wbr>percentage</h3>
114
- <div class="tsd-signature tsd-kind-icon">error_<wbr>threshold_<wbr>percentage<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
115
+ <a name="errorThresholdPercentage" class="tsd-anchor"></a>
116
+ <h3>error<wbr>Threshold<wbr>Percentage</h3>
117
+ <div class="tsd-signature tsd-kind-icon">error<wbr>Threshold<wbr>Percentage<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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#L578">types.ts:578</a></li>
120
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L507">datatypes.ts:507</a></li>
118
121
  </ul>
119
122
  </aside>
120
123
  <div class="tsd-comment tsd-typography">
@@ -124,12 +127,12 @@
124
127
  </div>
125
128
  </section>
126
129
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
127
- <a name="num_buckets" class="tsd-anchor"></a>
128
- <h3>num_<wbr>buckets</h3>
129
- <div class="tsd-signature tsd-kind-icon">num_<wbr>buckets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
130
+ <a name="numBuckets" class="tsd-anchor"></a>
131
+ <h3>num<wbr>Buckets</h3>
132
+ <div class="tsd-signature tsd-kind-icon">num<wbr>Buckets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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#L574">types.ts:574</a></li>
135
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L503">datatypes.ts:503</a></li>
133
136
  </ul>
134
137
  </aside>
135
138
  <div class="tsd-comment tsd-typography">
@@ -139,12 +142,12 @@
139
142
  </div>
140
143
  </section>
141
144
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
142
- <a name="rolling_window" class="tsd-anchor"></a>
143
- <h3>rolling_<wbr>window</h3>
144
- <div class="tsd-signature tsd-kind-icon">rolling_<wbr>window<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
145
+ <a name="rollingWindow" class="tsd-anchor"></a>
146
+ <h3>rolling<wbr>Window</h3>
147
+ <div class="tsd-signature tsd-kind-icon">rolling<wbr>Window<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
145
148
  <aside class="tsd-sources">
146
149
  <ul>
147
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L572">types.ts:572</a></li>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L501">datatypes.ts:501</a></li>
148
151
  </ul>
149
152
  </aside>
150
153
  <div class="tsd-comment tsd-typography">
@@ -154,12 +157,12 @@
154
157
  </div>
155
158
  </section>
156
159
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
157
- <a name="tripped_duration" class="tsd-anchor"></a>
158
- <h3>tripped_<wbr>duration</h3>
159
- <div class="tsd-signature tsd-kind-icon">tripped_<wbr>duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
160
+ <a name="trippedDuration" class="tsd-anchor"></a>
161
+ <h3>tripped<wbr>Duration</h3>
162
+ <div class="tsd-signature tsd-kind-icon">tripped<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
160
163
  <aside class="tsd-sources">
161
164
  <ul>
162
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L570">types.ts:570</a></li>
165
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L499">datatypes.ts:499</a></li>
163
166
  </ul>
164
167
  </aside>
165
168
  <div class="tsd-comment tsd-typography">
@@ -169,12 +172,12 @@
169
172
  </div>
170
173
  </section>
171
174
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
172
- <a name="volume_threshold" class="tsd-anchor"></a>
173
- <h3>volume_<wbr>threshold</h3>
174
- <div class="tsd-signature tsd-kind-icon">volume_<wbr>threshold<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
175
+ <a name="volumeThreshold" class="tsd-anchor"></a>
176
+ <h3>volume<wbr>Threshold</h3>
177
+ <div class="tsd-signature tsd-kind-icon">volume<wbr>Threshold<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
175
178
  <aside class="tsd-sources">
176
179
  <ul>
177
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L576">types.ts:576</a></li>
180
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L505">datatypes.ts:505</a></li>
178
181
  </ul>
179
182
  </aside>
180
183
  <div class="tsd-comment tsd-typography">
@@ -189,7 +192,16 @@
189
192
  <nav class="tsd-navigation primary">
190
193
  <ul>
191
194
  <li class=" ">
192
- <a href="../modules.html">Exports</a>
195
+ <a href="../modules.html">Modules</a>
196
+ </li>
197
+ <li class=" tsd-kind-module">
198
+ <a href="../modules/client.html">client</a>
199
+ </li>
200
+ <li class="current tsd-kind-module">
201
+ <a href="../modules/datatypes.html">datatypes</a>
202
+ </li>
203
+ <li class=" tsd-kind-module">
204
+ <a href="../modules/services.html">services</a>
193
205
  </li>
194
206
  </ul>
195
207
  </nav>
@@ -197,26 +209,26 @@
197
209
  <ul class="before-current">
198
210
  </ul>
199
211
  <ul class="current">
200
- <li class="current tsd-kind-interface">
201
- <a href="endpointcircuitbreaker.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker</a>
212
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
213
+ <a href="datatypes.EndpointCircuitBreaker.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker</a>
202
214
  <ul>
203
215
  <li class=" tsd-kind-property tsd-parent-kind-interface">
204
- <a href="endpointcircuitbreaker.html#enabled" class="tsd-kind-icon">enabled</a>
216
+ <a href="datatypes.EndpointCircuitBreaker.html#enabled" class="tsd-kind-icon">enabled</a>
205
217
  </li>
206
218
  <li class=" tsd-kind-property tsd-parent-kind-interface">
207
- <a href="endpointcircuitbreaker.html#error_threshold_percentage" class="tsd-kind-icon">error_<wbr>threshold_<wbr>percentage</a>
219
+ <a href="datatypes.EndpointCircuitBreaker.html#errorThresholdPercentage" class="tsd-kind-icon">error<wbr>Threshold<wbr>Percentage</a>
208
220
  </li>
209
221
  <li class=" tsd-kind-property tsd-parent-kind-interface">
210
- <a href="endpointcircuitbreaker.html#num_buckets" class="tsd-kind-icon">num_<wbr>buckets</a>
222
+ <a href="datatypes.EndpointCircuitBreaker.html#numBuckets" class="tsd-kind-icon">num<wbr>Buckets</a>
211
223
  </li>
212
224
  <li class=" tsd-kind-property tsd-parent-kind-interface">
213
- <a href="endpointcircuitbreaker.html#rolling_window" class="tsd-kind-icon">rolling_<wbr>window</a>
225
+ <a href="datatypes.EndpointCircuitBreaker.html#rollingWindow" class="tsd-kind-icon">rolling<wbr>Window</a>
214
226
  </li>
215
227
  <li class=" tsd-kind-property tsd-parent-kind-interface">
216
- <a href="endpointcircuitbreaker.html#tripped_duration" class="tsd-kind-icon">tripped_<wbr>duration</a>
228
+ <a href="datatypes.EndpointCircuitBreaker.html#trippedDuration" class="tsd-kind-icon">tripped<wbr>Duration</a>
217
229
  </li>
218
230
  <li class=" tsd-kind-property tsd-parent-kind-interface">
219
- <a href="endpointcircuitbreaker.html#volume_threshold" class="tsd-kind-icon">volume_<wbr>threshold</a>
231
+ <a href="datatypes.EndpointCircuitBreaker.html#volumeThreshold" class="tsd-kind-icon">volume<wbr>Threshold</a>
220
232
  </li>
221
233
  </ul>
222
234
  </li>
@@ -232,11 +244,11 @@
232
244
  <h2>Legend</h2>
233
245
  <div class="tsd-legend-group">
234
246
  <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>
247
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
248
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
237
249
  </ul>
238
250
  <ul class="tsd-legend">
239
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
251
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
240
252
  </ul>
241
253
  </div>
242
254
  </div>
package/docs/interfaces/{endpointcompression.html → datatypes.EndpointCompression.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="endpointcompression.html">EndpointCompression</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointCompression.html">EndpointCompression</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointCompression</h1>
@@ -80,7 +83,7 @@
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="endpointcompression.html#enabled" class="tsd-kind-icon">enabled</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointCompression.html#enabled" class="tsd-kind-icon">enabled</a></li>
84
87
  </ul>
85
88
  </section>
86
89
  </div>
@@ -94,12 +97,12 @@
94
97
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
95
98
  <aside class="tsd-sources">
96
99
  <ul>
97
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L493">types.ts:493</a></li>
100
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L431">datatypes.ts:431</a></li>
98
101
  </ul>
99
102
  </aside>
100
103
  <div class="tsd-comment tsd-typography">
101
104
  <div class="lead">
102
- <p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
105
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
103
106
  </div>
104
107
  </div>
105
108
  </section>
@@ -109,7 +112,16 @@
109
112
  <nav class="tsd-navigation primary">
110
113
  <ul>
111
114
  <li class=" ">
112
- <a href="../modules.html">Exports</a>
115
+ <a href="../modules.html">Modules</a>
116
+ </li>
117
+ <li class=" tsd-kind-module">
118
+ <a href="../modules/client.html">client</a>
119
+ </li>
120
+ <li class="current tsd-kind-module">
121
+ <a href="../modules/datatypes.html">datatypes</a>
122
+ </li>
123
+ <li class=" tsd-kind-module">
124
+ <a href="../modules/services.html">services</a>
113
125
  </li>
114
126
  </ul>
115
127
  </nav>
@@ -117,11 +129,11 @@
117
129
  <ul class="before-current">
118
130
  </ul>
119
131
  <ul class="current">
120
- <li class="current tsd-kind-interface">
121
- <a href="endpointcompression.html" class="tsd-kind-icon">Endpoint<wbr>Compression</a>
132
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
133
+ <a href="datatypes.EndpointCompression.html" class="tsd-kind-icon">Endpoint<wbr>Compression</a>
122
134
  <ul>
123
135
  <li class=" tsd-kind-property tsd-parent-kind-interface">
124
- <a href="endpointcompression.html#enabled" class="tsd-kind-icon">enabled</a>
136
+ <a href="datatypes.EndpointCompression.html#enabled" class="tsd-kind-icon">enabled</a>
125
137
  </li>
126
138
  </ul>
127
139
  </li>
@@ -137,11 +149,11 @@
137
149
  <h2>Legend</h2>
138
150
  <div class="tsd-legend-group">
139
151
  <ul class="tsd-legend">
140
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
141
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
152
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
153
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
142
154
  </ul>
143
155
  <ul class="tsd-legend">
144
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
156
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
145
157
  </ul>
146
158
  </div>
147
159
  </div>
package/docs/interfaces/{endpointippolicy.html → datatypes.EndpointIPPolicy.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="endpointippolicy.html">EndpointIPPolicy</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointIPPolicy.html">EndpointIPPolicy</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointIPPolicy</h1>
@@ -80,8 +83,8 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointippolicy.html#enabled" class="tsd-kind-icon">enabled</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointippolicy.html#ip_policies" class="tsd-kind-icon">ip_<wbr>policies</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointIPPolicy.html#enabled" class="tsd-kind-icon">enabled</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointIPPolicy.html#ipPolicies" class="tsd-kind-icon">ip<wbr>Policies</a></li>
85
88
  </ul>
86
89
  </section>
87
90
  </div>
@@ -95,22 +98,22 @@
95
98
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
96
99
  <aside class="tsd-sources">
97
100
  <ul>
98
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L555">types.ts:555</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L484">datatypes.ts:484</a></li>
99
102
  </ul>
100
103
  </aside>
101
104
  <div class="tsd-comment tsd-typography">
102
105
  <div class="lead">
103
- <p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
106
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
104
107
  </div>
105
108
  </div>
106
109
  </section>
107
110
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
108
- <a name="ip_policies" class="tsd-anchor"></a>
109
- <h3>ip_<wbr>policies</h3>
110
- <div class="tsd-signature tsd-kind-icon">ip_<wbr>policies<span class="tsd-signature-symbol">:</span> <a href="ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a><span class="tsd-signature-symbol">[]</span></div>
111
+ <a name="ipPolicies" class="tsd-anchor"></a>
112
+ <h3>ip<wbr>Policies</h3>
113
+ <div class="tsd-signature tsd-kind-icon">ip<wbr>Policies<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a><span class="tsd-signature-symbol">[]</span></div>
111
114
  <aside class="tsd-sources">
112
115
  <ul>
113
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L556">types.ts:556</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L485">datatypes.ts:485</a></li>
114
117
  </ul>
115
118
  </aside>
116
119
  </section>
@@ -120,7 +123,16 @@
120
123
  <nav class="tsd-navigation primary">
121
124
  <ul>
122
125
  <li class=" ">
123
- <a href="../modules.html">Exports</a>
126
+ <a href="../modules.html">Modules</a>
127
+ </li>
128
+ <li class=" tsd-kind-module">
129
+ <a href="../modules/client.html">client</a>
130
+ </li>
131
+ <li class="current tsd-kind-module">
132
+ <a href="../modules/datatypes.html">datatypes</a>
133
+ </li>
134
+ <li class=" tsd-kind-module">
135
+ <a href="../modules/services.html">services</a>
124
136
  </li>
125
137
  </ul>
126
138
  </nav>
@@ -128,14 +140,14 @@
128
140
  <ul class="before-current">
129
141
  </ul>
130
142
  <ul class="current">
131
- <li class="current tsd-kind-interface">
132
- <a href="endpointippolicy.html" class="tsd-kind-icon">EndpointIPPolicy</a>
143
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
144
+ <a href="datatypes.EndpointIPPolicy.html" class="tsd-kind-icon">EndpointIPPolicy</a>
133
145
  <ul>
134
146
  <li class=" tsd-kind-property tsd-parent-kind-interface">
135
- <a href="endpointippolicy.html#enabled" class="tsd-kind-icon">enabled</a>
147
+ <a href="datatypes.EndpointIPPolicy.html#enabled" class="tsd-kind-icon">enabled</a>
136
148
  </li>
137
149
  <li class=" tsd-kind-property tsd-parent-kind-interface">
138
- <a href="endpointippolicy.html#ip_policies" class="tsd-kind-icon">ip_<wbr>policies</a>
150
+ <a href="datatypes.EndpointIPPolicy.html#ipPolicies" class="tsd-kind-icon">ip<wbr>Policies</a>
139
151
  </li>
140
152
  </ul>
141
153
  </li>
@@ -151,11 +163,11 @@
151
163
  <h2>Legend</h2>
152
164
  <div class="tsd-legend-group">
153
165
  <ul class="tsd-legend">
154
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
155
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
166
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
167
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
156
168
  </ul>
157
169
  <ul class="tsd-legend">
158
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
170
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
159
171
  </ul>
160
172
  </div>
161
173
  </div>
package/docs/interfaces/{endpointippolicymutate.html → datatypes.EndpointIPPolicyMutate.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="endpointippolicymutate.html">EndpointIPPolicyMutate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointIPPolicyMutate.html">EndpointIPPolicyMutate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointIPPolicyMutate</h1>
@@ -80,8 +83,8 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointippolicymutate.html#enabled" class="tsd-kind-icon">enabled</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointippolicymutate.html#ip_policy_ids" class="tsd-kind-icon">ip_<wbr>policy_<wbr>ids</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointIPPolicyMutate.html#enabled" class="tsd-kind-icon">enabled</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointIPPolicyMutate.html#ipPolicyIds" class="tsd-kind-icon">ip<wbr>Policy<wbr>Ids</a></li>
85
88
  </ul>
86
89
  </section>
87
90
  </div>
@@ -95,22 +98,22 @@
95
98
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
96
99
  <aside class="tsd-sources">
97
100
  <ul>
98
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L561">types.ts:561</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L490">datatypes.ts:490</a></li>
99
102
  </ul>
100
103
  </aside>
101
104
  <div class="tsd-comment tsd-typography">
102
105
  <div class="lead">
103
- <p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
106
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
104
107
  </div>
105
108
  </div>
106
109
  </section>
107
110
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
108
- <a name="ip_policy_ids" class="tsd-anchor"></a>
109
- <h3>ip_<wbr>policy_<wbr>ids</h3>
110
- <div class="tsd-signature tsd-kind-icon">ip_<wbr>policy_<wbr>ids<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
111
+ <a name="ipPolicyIds" class="tsd-anchor"></a>
112
+ <h3>ip<wbr>Policy<wbr>Ids</h3>
113
+ <div class="tsd-signature tsd-kind-icon">ip<wbr>Policy<wbr>Ids<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
111
114
  <aside class="tsd-sources">
112
115
  <ul>
113
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L563">types.ts:563</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L492">datatypes.ts:492</a></li>
114
117
  </ul>
115
118
  </aside>
116
119
  <div class="tsd-comment tsd-typography">
@@ -125,7 +128,16 @@
125
128
  <nav class="tsd-navigation primary">
126
129
  <ul>
127
130
  <li class=" ">
128
- <a href="../modules.html">Exports</a>
131
+ <a href="../modules.html">Modules</a>
132
+ </li>
133
+ <li class=" tsd-kind-module">
134
+ <a href="../modules/client.html">client</a>
135
+ </li>
136
+ <li class="current tsd-kind-module">
137
+ <a href="../modules/datatypes.html">datatypes</a>
138
+ </li>
139
+ <li class=" tsd-kind-module">
140
+ <a href="../modules/services.html">services</a>
129
141
  </li>
130
142
  </ul>
131
143
  </nav>
@@ -133,14 +145,14 @@
133
145
  <ul class="before-current">
134
146
  </ul>
135
147
  <ul class="current">
136
- <li class="current tsd-kind-interface">
137
- <a href="endpointippolicymutate.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Mutate</a>
148
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
149
+ <a href="datatypes.EndpointIPPolicyMutate.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Mutate</a>
138
150
  <ul>
139
151
  <li class=" tsd-kind-property tsd-parent-kind-interface">
140
- <a href="endpointippolicymutate.html#enabled" class="tsd-kind-icon">enabled</a>
152
+ <a href="datatypes.EndpointIPPolicyMutate.html#enabled" class="tsd-kind-icon">enabled</a>
141
153
  </li>
142
154
  <li class=" tsd-kind-property tsd-parent-kind-interface">
143
- <a href="endpointippolicymutate.html#ip_policy_ids" class="tsd-kind-icon">ip_<wbr>policy_<wbr>ids</a>
155
+ <a href="datatypes.EndpointIPPolicyMutate.html#ipPolicyIds" class="tsd-kind-icon">ip<wbr>Policy<wbr>Ids</a>
144
156
  </li>
145
157
  </ul>
146
158
  </li>
@@ -156,11 +168,11 @@
156
168
  <h2>Legend</h2>
157
169
  <div class="tsd-legend-group">
158
170
  <ul class="tsd-legend">
159
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
160
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
171
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
172
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
161
173
  </ul>
162
174
  <ul class="tsd-legend">
163
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
175
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
164
176
  </ul>
165
177
  </div>
166
178
  </div>