@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/{ippolicyrulelist.html → datatypes.IPPolicyRuleList.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="ippolicyrulelist.html">IPPolicyRuleList</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.IPPolicyRuleList.html">IPPolicyRuleList</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface IPPolicyRuleList</h1>
@@ -80,9 +83,9 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicyrulelist.html#ip_policy_rules" class="tsd-kind-icon">ip_<wbr>policy_<wbr>rules</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicyrulelist.html#next_page_uri" class="tsd-kind-icon">next_<wbr>page_<wbr>uri</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicyrulelist.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRuleList.html#ipPolicyRules" class="tsd-kind-icon">ip<wbr>Policy<wbr>Rules</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRuleList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRuleList.html#uri" class="tsd-kind-icon">uri</a></li>
86
89
  </ul>
87
90
  </section>
88
91
  </div>
@@ -91,12 +94,12 @@
91
94
  <section class="tsd-panel-group tsd-member-group ">
92
95
  <h2>Properties</h2>
93
96
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
94
- <a name="ip_policy_rules" class="tsd-anchor"></a>
95
- <h3>ip_<wbr>policy_<wbr>rules</h3>
96
- <div class="tsd-signature tsd-kind-icon">ip_<wbr>policy_<wbr>rules<span class="tsd-signature-symbol">:</span> <a href="ippolicyrule.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicyRule</a><span class="tsd-signature-symbol">[]</span></div>
97
+ <a name="ipPolicyRules" class="tsd-anchor"></a>
98
+ <h3>ip<wbr>Policy<wbr>Rules</h3>
99
+ <div class="tsd-signature tsd-kind-icon">ip<wbr>Policy<wbr>Rules<span class="tsd-signature-symbol">:</span> <a href="datatypes.IPPolicyRule.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicyRule</a><span class="tsd-signature-symbol">[]</span></div>
97
100
  <aside class="tsd-sources">
98
101
  <ul>
99
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1179">types.ts:1179</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1383">datatypes.ts:1383</a></li>
100
103
  </ul>
101
104
  </aside>
102
105
  <div class="tsd-comment tsd-typography">
@@ -106,12 +109,12 @@
106
109
  </div>
107
110
  </section>
108
111
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
109
- <a name="next_page_uri" class="tsd-anchor"></a>
110
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> next_<wbr>page_<wbr>uri</h3>
111
- <div class="tsd-signature tsd-kind-icon">next_<wbr>page_<wbr>uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
112
+ <a name="nextPageUri" class="tsd-anchor"></a>
113
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> next<wbr>Page<wbr>Uri</h3>
114
+ <div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
112
115
  <aside class="tsd-sources">
113
116
  <ul>
114
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1183">types.ts:1183</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1387">datatypes.ts:1387</a></li>
115
118
  </ul>
116
119
  </aside>
117
120
  <div class="tsd-comment tsd-typography">
@@ -126,7 +129,7 @@
126
129
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
127
130
  <aside class="tsd-sources">
128
131
  <ul>
129
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1181">types.ts:1181</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1385">datatypes.ts:1385</a></li>
130
133
  </ul>
131
134
  </aside>
132
135
  <div class="tsd-comment tsd-typography">
@@ -141,7 +144,16 @@
141
144
  <nav class="tsd-navigation primary">
142
145
  <ul>
143
146
  <li class=" ">
144
- <a href="../modules.html">Exports</a>
147
+ <a href="../modules.html">Modules</a>
148
+ </li>
149
+ <li class=" tsd-kind-module">
150
+ <a href="../modules/client.html">client</a>
151
+ </li>
152
+ <li class="current tsd-kind-module">
153
+ <a href="../modules/datatypes.html">datatypes</a>
154
+ </li>
155
+ <li class=" tsd-kind-module">
156
+ <a href="../modules/services.html">services</a>
145
157
  </li>
146
158
  </ul>
147
159
  </nav>
@@ -149,17 +161,17 @@
149
161
  <ul class="before-current">
150
162
  </ul>
151
163
  <ul class="current">
152
- <li class="current tsd-kind-interface">
153
- <a href="ippolicyrulelist.html" class="tsd-kind-icon">IPPolicy<wbr>Rule<wbr>List</a>
164
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
165
+ <a href="datatypes.IPPolicyRuleList.html" class="tsd-kind-icon">IPPolicy<wbr>Rule<wbr>List</a>
154
166
  <ul>
155
167
  <li class=" tsd-kind-property tsd-parent-kind-interface">
156
- <a href="ippolicyrulelist.html#ip_policy_rules" class="tsd-kind-icon">ip_<wbr>policy_<wbr>rules</a>
168
+ <a href="datatypes.IPPolicyRuleList.html#ipPolicyRules" class="tsd-kind-icon">ip<wbr>Policy<wbr>Rules</a>
157
169
  </li>
158
170
  <li class=" tsd-kind-property tsd-parent-kind-interface">
159
- <a href="ippolicyrulelist.html#next_page_uri" class="tsd-kind-icon">next_<wbr>page_<wbr>uri</a>
171
+ <a href="datatypes.IPPolicyRuleList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a>
160
172
  </li>
161
173
  <li class=" tsd-kind-property tsd-parent-kind-interface">
162
- <a href="ippolicyrulelist.html#uri" class="tsd-kind-icon">uri</a>
174
+ <a href="datatypes.IPPolicyRuleList.html#uri" class="tsd-kind-icon">uri</a>
163
175
  </li>
164
176
  </ul>
165
177
  </li>
@@ -175,11 +187,11 @@
175
187
  <h2>Legend</h2>
176
188
  <div class="tsd-legend-group">
177
189
  <ul class="tsd-legend">
178
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
179
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
190
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
191
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
180
192
  </ul>
181
193
  <ul class="tsd-legend">
182
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
194
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
183
195
  </ul>
184
196
  </div>
185
197
  </div>
package/docs/interfaces/{ippolicyruleupdate.html → datatypes.IPPolicyRuleUpdate.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="ippolicyruleupdate.html">IPPolicyRuleUpdate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.IPPolicyRuleUpdate.html">IPPolicyRuleUpdate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface IPPolicyRuleUpdate</h1>
@@ -80,10 +83,10 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicyruleupdate.html#cidr" class="tsd-kind-icon">cidr</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicyruleupdate.html#description" class="tsd-kind-icon">description</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicyruleupdate.html#id" class="tsd-kind-icon">id</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicyruleupdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRuleUpdate.html#cidr" class="tsd-kind-icon">cidr</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRuleUpdate.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRuleUpdate.html#id" class="tsd-kind-icon">id</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRuleUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
87
90
  </ul>
88
91
  </section>
89
92
  </div>
@@ -97,7 +100,7 @@
97
100
  <div class="tsd-signature tsd-kind-icon">cidr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
98
101
  <aside class="tsd-sources">
99
102
  <ul>
100
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1157">types.ts:1157</a></li>
103
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1359">datatypes.ts:1359</a></li>
101
104
  </ul>
102
105
  </aside>
103
106
  <div class="tsd-comment tsd-typography">
@@ -112,7 +115,7 @@
112
115
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
113
116
  <aside class="tsd-sources">
114
117
  <ul>
115
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1153">types.ts:1153</a></li>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1355">datatypes.ts:1355</a></li>
116
119
  </ul>
117
120
  </aside>
118
121
  <div class="tsd-comment tsd-typography">
@@ -127,7 +130,7 @@
127
130
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
128
131
  <aside class="tsd-sources">
129
132
  <ul>
130
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1151">types.ts:1151</a></li>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1353">datatypes.ts:1353</a></li>
131
134
  </ul>
132
135
  </aside>
133
136
  </section>
@@ -137,7 +140,7 @@
137
140
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
138
141
  <aside class="tsd-sources">
139
142
  <ul>
140
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1155">types.ts:1155</a></li>
143
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1357">datatypes.ts:1357</a></li>
141
144
  </ul>
142
145
  </aside>
143
146
  <div class="tsd-comment tsd-typography">
@@ -152,7 +155,16 @@
152
155
  <nav class="tsd-navigation primary">
153
156
  <ul>
154
157
  <li class=" ">
155
- <a href="../modules.html">Exports</a>
158
+ <a href="../modules.html">Modules</a>
159
+ </li>
160
+ <li class=" tsd-kind-module">
161
+ <a href="../modules/client.html">client</a>
162
+ </li>
163
+ <li class="current tsd-kind-module">
164
+ <a href="../modules/datatypes.html">datatypes</a>
165
+ </li>
166
+ <li class=" tsd-kind-module">
167
+ <a href="../modules/services.html">services</a>
156
168
  </li>
157
169
  </ul>
158
170
  </nav>
@@ -160,20 +172,20 @@
160
172
  <ul class="before-current">
161
173
  </ul>
162
174
  <ul class="current">
163
- <li class="current tsd-kind-interface">
164
- <a href="ippolicyruleupdate.html" class="tsd-kind-icon">IPPolicy<wbr>Rule<wbr>Update</a>
175
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
176
+ <a href="datatypes.IPPolicyRuleUpdate.html" class="tsd-kind-icon">IPPolicy<wbr>Rule<wbr>Update</a>
165
177
  <ul>
166
178
  <li class=" tsd-kind-property tsd-parent-kind-interface">
167
- <a href="ippolicyruleupdate.html#cidr" class="tsd-kind-icon">cidr</a>
179
+ <a href="datatypes.IPPolicyRuleUpdate.html#cidr" class="tsd-kind-icon">cidr</a>
168
180
  </li>
169
181
  <li class=" tsd-kind-property tsd-parent-kind-interface">
170
- <a href="ippolicyruleupdate.html#description" class="tsd-kind-icon">description</a>
182
+ <a href="datatypes.IPPolicyRuleUpdate.html#description" class="tsd-kind-icon">description</a>
171
183
  </li>
172
184
  <li class=" tsd-kind-property tsd-parent-kind-interface">
173
- <a href="ippolicyruleupdate.html#id" class="tsd-kind-icon">id</a>
185
+ <a href="datatypes.IPPolicyRuleUpdate.html#id" class="tsd-kind-icon">id</a>
174
186
  </li>
175
187
  <li class=" tsd-kind-property tsd-parent-kind-interface">
176
- <a href="ippolicyruleupdate.html#metadata" class="tsd-kind-icon">metadata</a>
188
+ <a href="datatypes.IPPolicyRuleUpdate.html#metadata" class="tsd-kind-icon">metadata</a>
177
189
  </li>
178
190
  </ul>
179
191
  </li>
@@ -189,11 +201,11 @@
189
201
  <h2>Legend</h2>
190
202
  <div class="tsd-legend-group">
191
203
  <ul class="tsd-legend">
192
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
193
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
204
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
205
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
194
206
  </ul>
195
207
  <ul class="tsd-legend">
196
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
208
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
197
209
  </ul>
198
210
  </div>
199
211
  </div>
package/docs/interfaces/{ippolicyupdate.html → datatypes.IPPolicyUpdate.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="ippolicyupdate.html">IPPolicyUpdate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.IPPolicyUpdate.html">IPPolicyUpdate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface IPPolicyUpdate</h1>
@@ -80,9 +83,9 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicyupdate.html#description" class="tsd-kind-icon">description</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicyupdate.html#id" class="tsd-kind-icon">id</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ippolicyupdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyUpdate.html#description" class="tsd-kind-icon">description</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyUpdate.html#id" class="tsd-kind-icon">id</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
86
89
  </ul>
87
90
  </section>
88
91
  </div>
@@ -96,7 +99,7 @@
96
99
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
97
100
  <aside class="tsd-sources">
98
101
  <ul>
99
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1110">types.ts:1110</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1312">datatypes.ts:1312</a></li>
100
103
  </ul>
101
104
  </aside>
102
105
  <div class="tsd-comment tsd-typography">
@@ -111,7 +114,7 @@
111
114
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
112
115
  <aside class="tsd-sources">
113
116
  <ul>
114
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1108">types.ts:1108</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1310">datatypes.ts:1310</a></li>
115
118
  </ul>
116
119
  </aside>
117
120
  </section>
@@ -121,7 +124,7 @@
121
124
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
122
125
  <aside class="tsd-sources">
123
126
  <ul>
124
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1112">types.ts:1112</a></li>
127
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1314">datatypes.ts:1314</a></li>
125
128
  </ul>
126
129
  </aside>
127
130
  <div class="tsd-comment tsd-typography">
@@ -136,7 +139,16 @@
136
139
  <nav class="tsd-navigation primary">
137
140
  <ul>
138
141
  <li class=" ">
139
- <a href="../modules.html">Exports</a>
142
+ <a href="../modules.html">Modules</a>
143
+ </li>
144
+ <li class=" tsd-kind-module">
145
+ <a href="../modules/client.html">client</a>
146
+ </li>
147
+ <li class="current tsd-kind-module">
148
+ <a href="../modules/datatypes.html">datatypes</a>
149
+ </li>
150
+ <li class=" tsd-kind-module">
151
+ <a href="../modules/services.html">services</a>
140
152
  </li>
141
153
  </ul>
142
154
  </nav>
@@ -144,17 +156,17 @@
144
156
  <ul class="before-current">
145
157
  </ul>
146
158
  <ul class="current">
147
- <li class="current tsd-kind-interface">
148
- <a href="ippolicyupdate.html" class="tsd-kind-icon">IPPolicy<wbr>Update</a>
159
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
160
+ <a href="datatypes.IPPolicyUpdate.html" class="tsd-kind-icon">IPPolicy<wbr>Update</a>
149
161
  <ul>
150
162
  <li class=" tsd-kind-property tsd-parent-kind-interface">
151
- <a href="ippolicyupdate.html#description" class="tsd-kind-icon">description</a>
163
+ <a href="datatypes.IPPolicyUpdate.html#description" class="tsd-kind-icon">description</a>
152
164
  </li>
153
165
  <li class=" tsd-kind-property tsd-parent-kind-interface">
154
- <a href="ippolicyupdate.html#id" class="tsd-kind-icon">id</a>
166
+ <a href="datatypes.IPPolicyUpdate.html#id" class="tsd-kind-icon">id</a>
155
167
  </li>
156
168
  <li class=" tsd-kind-property tsd-parent-kind-interface">
157
- <a href="ippolicyupdate.html#metadata" class="tsd-kind-icon">metadata</a>
169
+ <a href="datatypes.IPPolicyUpdate.html#metadata" class="tsd-kind-icon">metadata</a>
158
170
  </li>
159
171
  </ul>
160
172
  </li>
@@ -170,11 +182,11 @@
170
182
  <h2>Legend</h2>
171
183
  <div class="tsd-legend-group">
172
184
  <ul class="tsd-legend">
173
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
174
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
185
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
186
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
175
187
  </ul>
176
188
  <ul class="tsd-legend">
177
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
189
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
178
190
  </ul>
179
191
  </div>
180
192
  </div>
package/docs/interfaces/{iprestriction.html → datatypes.IPRestriction.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="iprestriction.html">IPRestriction</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.IPRestriction.html">IPRestriction</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface IPRestriction</h1>
@@ -80,14 +83,14 @@
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="iprestriction.html#created_at" class="tsd-kind-icon">created_<wbr>at</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestriction.html#description" class="tsd-kind-icon">description</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestriction.html#enforced" class="tsd-kind-icon">enforced</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestriction.html#id" class="tsd-kind-icon">id</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestriction.html#ip_policies" class="tsd-kind-icon">ip_<wbr>policies</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestriction.html#metadata" class="tsd-kind-icon">metadata</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestriction.html#type" class="tsd-kind-icon">type</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestriction.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#enforced" class="tsd-kind-icon">enforced</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#id" class="tsd-kind-icon">id</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#ipPolicies" class="tsd-kind-icon">ip<wbr>Policies</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#metadata" class="tsd-kind-icon">metadata</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#type" class="tsd-kind-icon">type</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestriction.html#uri" class="tsd-kind-icon">uri</a></li>
91
94
  </ul>
92
95
  </section>
93
96
  </div>
@@ -96,12 +99,12 @@
96
99
  <section class="tsd-panel-group tsd-member-group ">
97
100
  <h2>Properties</h2>
98
101
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
99
- <a name="created_at" 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>
102
+ <a name="createdAt" class="tsd-anchor"></a>
103
+ <h3>created<wbr>At</h3>
104
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
102
105
  <aside class="tsd-sources">
103
106
  <ul>
104
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1217">types.ts:1217</a></li>
107
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1421">datatypes.ts:1421</a></li>
105
108
  </ul>
106
109
  </aside>
107
110
  <div class="tsd-comment tsd-typography">
@@ -116,7 +119,7 @@
116
119
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
117
120
  <aside class="tsd-sources">
118
121
  <ul>
119
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1219">types.ts:1219</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1423">datatypes.ts:1423</a></li>
120
123
  </ul>
121
124
  </aside>
122
125
  <div class="tsd-comment tsd-typography">
@@ -131,7 +134,7 @@
131
134
  <div class="tsd-signature tsd-kind-icon">enforced<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
132
135
  <aside class="tsd-sources">
133
136
  <ul>
134
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1223">types.ts:1223</a></li>
137
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1427">datatypes.ts:1427</a></li>
135
138
  </ul>
136
139
  </aside>
137
140
  <div class="tsd-comment tsd-typography">
@@ -146,7 +149,7 @@
146
149
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
147
150
  <aside class="tsd-sources">
148
151
  <ul>
149
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1213">types.ts:1213</a></li>
152
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1417">datatypes.ts:1417</a></li>
150
153
  </ul>
151
154
  </aside>
152
155
  <div class="tsd-comment tsd-typography">
@@ -156,12 +159,12 @@
156
159
  </div>
157
160
  </section>
158
161
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
159
- <a name="ip_policies" class="tsd-anchor"></a>
160
- <h3>ip_<wbr>policies</h3>
161
- <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>
162
+ <a name="ipPolicies" class="tsd-anchor"></a>
163
+ <h3>ip<wbr>Policies</h3>
164
+ <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>
162
165
  <aside class="tsd-sources">
163
166
  <ul>
164
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1227">types.ts:1227</a></li>
167
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1431">datatypes.ts:1431</a></li>
165
168
  </ul>
166
169
  </aside>
167
170
  <div class="tsd-comment tsd-typography">
@@ -176,7 +179,7 @@
176
179
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
177
180
  <aside class="tsd-sources">
178
181
  <ul>
179
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1221">types.ts:1221</a></li>
182
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1425">datatypes.ts:1425</a></li>
180
183
  </ul>
181
184
  </aside>
182
185
  <div class="tsd-comment tsd-typography">
@@ -191,12 +194,12 @@
191
194
  <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
192
195
  <aside class="tsd-sources">
193
196
  <ul>
194
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1225">types.ts:1225</a></li>
197
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1429">datatypes.ts:1429</a></li>
195
198
  </ul>
196
199
  </aside>
197
200
  <div class="tsd-comment tsd-typography">
198
201
  <div class="lead">
199
- <p>the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: dashboard, api, agent, and endpoints</p>
202
+ <p>the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: <code>dashboard</code>, <code>api</code>, <code>agent</code>, and <code>endpoints</code></p>
200
203
  </div>
201
204
  </div>
202
205
  </section>
@@ -206,7 +209,7 @@
206
209
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
207
210
  <aside class="tsd-sources">
208
211
  <ul>
209
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1215">types.ts:1215</a></li>
212
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1419">datatypes.ts:1419</a></li>
210
213
  </ul>
211
214
  </aside>
212
215
  <div class="tsd-comment tsd-typography">
@@ -221,7 +224,16 @@
221
224
  <nav class="tsd-navigation primary">
222
225
  <ul>
223
226
  <li class=" ">
224
- <a href="../modules.html">Exports</a>
227
+ <a href="../modules.html">Modules</a>
228
+ </li>
229
+ <li class=" tsd-kind-module">
230
+ <a href="../modules/client.html">client</a>
231
+ </li>
232
+ <li class="current tsd-kind-module">
233
+ <a href="../modules/datatypes.html">datatypes</a>
234
+ </li>
235
+ <li class=" tsd-kind-module">
236
+ <a href="../modules/services.html">services</a>
225
237
  </li>
226
238
  </ul>
227
239
  </nav>
@@ -229,32 +241,32 @@
229
241
  <ul class="before-current">
230
242
  </ul>
231
243
  <ul class="current">
232
- <li class="current tsd-kind-interface">
233
- <a href="iprestriction.html" class="tsd-kind-icon">IPRestriction</a>
244
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
245
+ <a href="datatypes.IPRestriction.html" class="tsd-kind-icon">IPRestriction</a>
234
246
  <ul>
235
247
  <li class=" tsd-kind-property tsd-parent-kind-interface">
236
- <a href="iprestriction.html#created_at" class="tsd-kind-icon">created_<wbr>at</a>
248
+ <a href="datatypes.IPRestriction.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
237
249
  </li>
238
250
  <li class=" tsd-kind-property tsd-parent-kind-interface">
239
- <a href="iprestriction.html#description" class="tsd-kind-icon">description</a>
251
+ <a href="datatypes.IPRestriction.html#description" class="tsd-kind-icon">description</a>
240
252
  </li>
241
253
  <li class=" tsd-kind-property tsd-parent-kind-interface">
242
- <a href="iprestriction.html#enforced" class="tsd-kind-icon">enforced</a>
254
+ <a href="datatypes.IPRestriction.html#enforced" class="tsd-kind-icon">enforced</a>
243
255
  </li>
244
256
  <li class=" tsd-kind-property tsd-parent-kind-interface">
245
- <a href="iprestriction.html#id" class="tsd-kind-icon">id</a>
257
+ <a href="datatypes.IPRestriction.html#id" class="tsd-kind-icon">id</a>
246
258
  </li>
247
259
  <li class=" tsd-kind-property tsd-parent-kind-interface">
248
- <a href="iprestriction.html#ip_policies" class="tsd-kind-icon">ip_<wbr>policies</a>
260
+ <a href="datatypes.IPRestriction.html#ipPolicies" class="tsd-kind-icon">ip<wbr>Policies</a>
249
261
  </li>
250
262
  <li class=" tsd-kind-property tsd-parent-kind-interface">
251
- <a href="iprestriction.html#metadata" class="tsd-kind-icon">metadata</a>
263
+ <a href="datatypes.IPRestriction.html#metadata" class="tsd-kind-icon">metadata</a>
252
264
  </li>
253
265
  <li class=" tsd-kind-property tsd-parent-kind-interface">
254
- <a href="iprestriction.html#type" class="tsd-kind-icon">type</a>
266
+ <a href="datatypes.IPRestriction.html#type" class="tsd-kind-icon">type</a>
255
267
  </li>
256
268
  <li class=" tsd-kind-property tsd-parent-kind-interface">
257
- <a href="iprestriction.html#uri" class="tsd-kind-icon">uri</a>
269
+ <a href="datatypes.IPRestriction.html#uri" class="tsd-kind-icon">uri</a>
258
270
  </li>
259
271
  </ul>
260
272
  </li>
@@ -270,11 +282,11 @@
270
282
  <h2>Legend</h2>
271
283
  <div class="tsd-legend-group">
272
284
  <ul class="tsd-legend">
273
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
274
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
285
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
286
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
275
287
  </ul>
276
288
  <ul class="tsd-legend">
277
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
289
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
278
290
  </ul>
279
291
  </div>
280
292
  </div>