@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/{iprestrictioncreate.html → datatypes.IPRestrictionCreate.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="iprestrictioncreate.html">IPRestrictionCreate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.IPRestrictionCreate.html">IPRestrictionCreate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface IPRestrictionCreate</h1>
@@ -80,11 +83,11 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestrictioncreate.html#description" class="tsd-kind-icon">description</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestrictioncreate.html#enforced" class="tsd-kind-icon">enforced</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestrictioncreate.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="iprestrictioncreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestrictioncreate.html#type" class="tsd-kind-icon">type</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestrictionCreate.html#description" class="tsd-kind-icon">description</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestrictionCreate.html#enforced" class="tsd-kind-icon">enforced</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestrictionCreate.html#ipPolicyIds" class="tsd-kind-icon">ip<wbr>Policy<wbr>Ids</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestrictionCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestrictionCreate.html#type" class="tsd-kind-icon">type</a></li>
88
91
  </ul>
89
92
  </section>
90
93
  </div>
@@ -98,7 +101,7 @@
98
101
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
102
  <aside class="tsd-sources">
100
103
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1188">types.ts:1188</a></li>
104
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1392">datatypes.ts:1392</a></li>
102
105
  </ul>
103
106
  </aside>
104
107
  <div class="tsd-comment tsd-typography">
@@ -113,7 +116,7 @@
113
116
  <div class="tsd-signature tsd-kind-icon">enforced<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
114
117
  <aside class="tsd-sources">
115
118
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1192">types.ts:1192</a></li>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1396">datatypes.ts:1396</a></li>
117
120
  </ul>
118
121
  </aside>
119
122
  <div class="tsd-comment tsd-typography">
@@ -123,12 +126,12 @@
123
126
  </div>
124
127
  </section>
125
128
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
126
- <a name="ip_policy_ids" class="tsd-anchor"></a>
127
- <h3>ip_<wbr>policy_<wbr>ids</h3>
128
- <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>
129
+ <a name="ipPolicyIds" class="tsd-anchor"></a>
130
+ <h3>ip<wbr>Policy<wbr>Ids</h3>
131
+ <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>
129
132
  <aside class="tsd-sources">
130
133
  <ul>
131
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1196">types.ts:1196</a></li>
134
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1400">datatypes.ts:1400</a></li>
132
135
  </ul>
133
136
  </aside>
134
137
  <div class="tsd-comment tsd-typography">
@@ -143,7 +146,7 @@
143
146
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
144
147
  <aside class="tsd-sources">
145
148
  <ul>
146
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1190">types.ts:1190</a></li>
149
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1394">datatypes.ts:1394</a></li>
147
150
  </ul>
148
151
  </aside>
149
152
  <div class="tsd-comment tsd-typography">
@@ -158,12 +161,12 @@
158
161
  <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
159
162
  <aside class="tsd-sources">
160
163
  <ul>
161
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1194">types.ts:1194</a></li>
164
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1398">datatypes.ts:1398</a></li>
162
165
  </ul>
163
166
  </aside>
164
167
  <div class="tsd-comment tsd-typography">
165
168
  <div class="lead">
166
- <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>
169
+ <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>
167
170
  </div>
168
171
  </div>
169
172
  </section>
@@ -173,7 +176,16 @@
173
176
  <nav class="tsd-navigation primary">
174
177
  <ul>
175
178
  <li class=" ">
176
- <a href="../modules.html">Exports</a>
179
+ <a href="../modules.html">Modules</a>
180
+ </li>
181
+ <li class=" tsd-kind-module">
182
+ <a href="../modules/client.html">client</a>
183
+ </li>
184
+ <li class="current tsd-kind-module">
185
+ <a href="../modules/datatypes.html">datatypes</a>
186
+ </li>
187
+ <li class=" tsd-kind-module">
188
+ <a href="../modules/services.html">services</a>
177
189
  </li>
178
190
  </ul>
179
191
  </nav>
@@ -181,23 +193,23 @@
181
193
  <ul class="before-current">
182
194
  </ul>
183
195
  <ul class="current">
184
- <li class="current tsd-kind-interface">
185
- <a href="iprestrictioncreate.html" class="tsd-kind-icon">IPRestriction<wbr>Create</a>
196
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
197
+ <a href="datatypes.IPRestrictionCreate.html" class="tsd-kind-icon">IPRestriction<wbr>Create</a>
186
198
  <ul>
187
199
  <li class=" tsd-kind-property tsd-parent-kind-interface">
188
- <a href="iprestrictioncreate.html#description" class="tsd-kind-icon">description</a>
200
+ <a href="datatypes.IPRestrictionCreate.html#description" class="tsd-kind-icon">description</a>
189
201
  </li>
190
202
  <li class=" tsd-kind-property tsd-parent-kind-interface">
191
- <a href="iprestrictioncreate.html#enforced" class="tsd-kind-icon">enforced</a>
203
+ <a href="datatypes.IPRestrictionCreate.html#enforced" class="tsd-kind-icon">enforced</a>
192
204
  </li>
193
205
  <li class=" tsd-kind-property tsd-parent-kind-interface">
194
- <a href="iprestrictioncreate.html#ip_policy_ids" class="tsd-kind-icon">ip_<wbr>policy_<wbr>ids</a>
206
+ <a href="datatypes.IPRestrictionCreate.html#ipPolicyIds" class="tsd-kind-icon">ip<wbr>Policy<wbr>Ids</a>
195
207
  </li>
196
208
  <li class=" tsd-kind-property tsd-parent-kind-interface">
197
- <a href="iprestrictioncreate.html#metadata" class="tsd-kind-icon">metadata</a>
209
+ <a href="datatypes.IPRestrictionCreate.html#metadata" class="tsd-kind-icon">metadata</a>
198
210
  </li>
199
211
  <li class=" tsd-kind-property tsd-parent-kind-interface">
200
- <a href="iprestrictioncreate.html#type" class="tsd-kind-icon">type</a>
212
+ <a href="datatypes.IPRestrictionCreate.html#type" class="tsd-kind-icon">type</a>
201
213
  </li>
202
214
  </ul>
203
215
  </li>
@@ -213,11 +225,11 @@
213
225
  <h2>Legend</h2>
214
226
  <div class="tsd-legend-group">
215
227
  <ul class="tsd-legend">
216
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
217
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
228
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
229
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
218
230
  </ul>
219
231
  <ul class="tsd-legend">
220
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
232
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
221
233
  </ul>
222
234
  </div>
223
235
  </div>
package/docs/interfaces/{iprestrictionlist.html → datatypes.IPRestrictionList.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="iprestrictionlist.html">IPRestrictionList</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.IPRestrictionList.html">IPRestrictionList</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface IPRestrictionList</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="iprestrictionlist.html#ip_restrictions" class="tsd-kind-icon">ip_<wbr>restrictions</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestrictionlist.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="iprestrictionlist.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestrictionList.html#ipRestrictions" class="tsd-kind-icon">ip<wbr>Restrictions</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestrictionList.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.IPRestrictionList.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_restrictions" class="tsd-anchor"></a>
95
- <h3>ip_<wbr>restrictions</h3>
96
- <div class="tsd-signature tsd-kind-icon">ip_<wbr>restrictions<span class="tsd-signature-symbol">:</span> <a href="iprestriction.html" class="tsd-signature-type" data-tsd-kind="Interface">IPRestriction</a><span class="tsd-signature-symbol">[]</span></div>
97
+ <a name="ipRestrictions" class="tsd-anchor"></a>
98
+ <h3>ip<wbr>Restrictions</h3>
99
+ <div class="tsd-signature tsd-kind-icon">ip<wbr>Restrictions<span class="tsd-signature-symbol">:</span> <a href="datatypes.IPRestriction.html" class="tsd-signature-type" data-tsd-kind="Interface">IPRestriction</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#L1232">types.ts:1232</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1436">datatypes.ts:1436</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#L1236">types.ts:1236</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1440">datatypes.ts:1440</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#L1234">types.ts:1234</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1438">datatypes.ts:1438</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="iprestrictionlist.html" class="tsd-kind-icon">IPRestriction<wbr>List</a>
164
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
165
+ <a href="datatypes.IPRestrictionList.html" class="tsd-kind-icon">IPRestriction<wbr>List</a>
154
166
  <ul>
155
167
  <li class=" tsd-kind-property tsd-parent-kind-interface">
156
- <a href="iprestrictionlist.html#ip_restrictions" class="tsd-kind-icon">ip_<wbr>restrictions</a>
168
+ <a href="datatypes.IPRestrictionList.html#ipRestrictions" class="tsd-kind-icon">ip<wbr>Restrictions</a>
157
169
  </li>
158
170
  <li class=" tsd-kind-property tsd-parent-kind-interface">
159
- <a href="iprestrictionlist.html#next_page_uri" class="tsd-kind-icon">next_<wbr>page_<wbr>uri</a>
171
+ <a href="datatypes.IPRestrictionList.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="iprestrictionlist.html#uri" class="tsd-kind-icon">uri</a>
174
+ <a href="datatypes.IPRestrictionList.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/{iprestrictionupdate.html → datatypes.IPRestrictionUpdate.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="iprestrictionupdate.html">IPRestrictionUpdate</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.IPRestrictionUpdate.html">IPRestrictionUpdate</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface IPRestrictionUpdate</h1>
@@ -80,11 +83,11 @@
80
83
  <section class="tsd-index-section ">
81
84
  <h3>Properties</h3>
82
85
  <ul class="tsd-index-list">
83
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestrictionupdate.html#description" class="tsd-kind-icon">description</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestrictionupdate.html#enforced" class="tsd-kind-icon">enforced</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestrictionupdate.html#id" class="tsd-kind-icon">id</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestrictionupdate.html#ip_policy_ids" class="tsd-kind-icon">ip_<wbr>policy_<wbr>ids</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="iprestrictionupdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestrictionUpdate.html#description" class="tsd-kind-icon">description</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestrictionUpdate.html#enforced" class="tsd-kind-icon">enforced</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestrictionUpdate.html#id" class="tsd-kind-icon">id</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestrictionUpdate.html#ipPolicyIds" class="tsd-kind-icon">ip<wbr>Policy<wbr>Ids</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPRestrictionUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
88
91
  </ul>
89
92
  </section>
90
93
  </div>
@@ -98,7 +101,7 @@
98
101
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
102
  <aside class="tsd-sources">
100
103
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1202">types.ts:1202</a></li>
104
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1406">datatypes.ts:1406</a></li>
102
105
  </ul>
103
106
  </aside>
104
107
  <div class="tsd-comment tsd-typography">
@@ -113,7 +116,7 @@
113
116
  <div class="tsd-signature tsd-kind-icon">enforced<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
114
117
  <aside class="tsd-sources">
115
118
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1206">types.ts:1206</a></li>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1410">datatypes.ts:1410</a></li>
117
120
  </ul>
118
121
  </aside>
119
122
  <div class="tsd-comment tsd-typography">
@@ -128,17 +131,17 @@
128
131
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
129
132
  <aside class="tsd-sources">
130
133
  <ul>
131
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1200">types.ts:1200</a></li>
134
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1404">datatypes.ts:1404</a></li>
132
135
  </ul>
133
136
  </aside>
134
137
  </section>
135
138
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
136
- <a name="ip_policy_ids" class="tsd-anchor"></a>
137
- <h3>ip_<wbr>policy_<wbr>ids</h3>
138
- <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>
139
+ <a name="ipPolicyIds" class="tsd-anchor"></a>
140
+ <h3>ip<wbr>Policy<wbr>Ids</h3>
141
+ <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>
139
142
  <aside class="tsd-sources">
140
143
  <ul>
141
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1208">types.ts:1208</a></li>
144
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1412">datatypes.ts:1412</a></li>
142
145
  </ul>
143
146
  </aside>
144
147
  <div class="tsd-comment tsd-typography">
@@ -153,7 +156,7 @@
153
156
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
154
157
  <aside class="tsd-sources">
155
158
  <ul>
156
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L1204">types.ts:1204</a></li>
159
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1408">datatypes.ts:1408</a></li>
157
160
  </ul>
158
161
  </aside>
159
162
  <div class="tsd-comment tsd-typography">
@@ -168,7 +171,16 @@
168
171
  <nav class="tsd-navigation primary">
169
172
  <ul>
170
173
  <li class=" ">
171
- <a href="../modules.html">Exports</a>
174
+ <a href="../modules.html">Modules</a>
175
+ </li>
176
+ <li class=" tsd-kind-module">
177
+ <a href="../modules/client.html">client</a>
178
+ </li>
179
+ <li class="current tsd-kind-module">
180
+ <a href="../modules/datatypes.html">datatypes</a>
181
+ </li>
182
+ <li class=" tsd-kind-module">
183
+ <a href="../modules/services.html">services</a>
172
184
  </li>
173
185
  </ul>
174
186
  </nav>
@@ -176,23 +188,23 @@
176
188
  <ul class="before-current">
177
189
  </ul>
178
190
  <ul class="current">
179
- <li class="current tsd-kind-interface">
180
- <a href="iprestrictionupdate.html" class="tsd-kind-icon">IPRestriction<wbr>Update</a>
191
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
192
+ <a href="datatypes.IPRestrictionUpdate.html" class="tsd-kind-icon">IPRestriction<wbr>Update</a>
181
193
  <ul>
182
194
  <li class=" tsd-kind-property tsd-parent-kind-interface">
183
- <a href="iprestrictionupdate.html#description" class="tsd-kind-icon">description</a>
195
+ <a href="datatypes.IPRestrictionUpdate.html#description" class="tsd-kind-icon">description</a>
184
196
  </li>
185
197
  <li class=" tsd-kind-property tsd-parent-kind-interface">
186
- <a href="iprestrictionupdate.html#enforced" class="tsd-kind-icon">enforced</a>
198
+ <a href="datatypes.IPRestrictionUpdate.html#enforced" class="tsd-kind-icon">enforced</a>
187
199
  </li>
188
200
  <li class=" tsd-kind-property tsd-parent-kind-interface">
189
- <a href="iprestrictionupdate.html#id" class="tsd-kind-icon">id</a>
201
+ <a href="datatypes.IPRestrictionUpdate.html#id" class="tsd-kind-icon">id</a>
190
202
  </li>
191
203
  <li class=" tsd-kind-property tsd-parent-kind-interface">
192
- <a href="iprestrictionupdate.html#ip_policy_ids" class="tsd-kind-icon">ip_<wbr>policy_<wbr>ids</a>
204
+ <a href="datatypes.IPRestrictionUpdate.html#ipPolicyIds" class="tsd-kind-icon">ip<wbr>Policy<wbr>Ids</a>
193
205
  </li>
194
206
  <li class=" tsd-kind-property tsd-parent-kind-interface">
195
- <a href="iprestrictionupdate.html#metadata" class="tsd-kind-icon">metadata</a>
207
+ <a href="datatypes.IPRestrictionUpdate.html#metadata" class="tsd-kind-icon">metadata</a>
196
208
  </li>
197
209
  </ul>
198
210
  </li>
@@ -208,11 +220,11 @@
208
220
  <h2>Legend</h2>
209
221
  <div class="tsd-legend-group">
210
222
  <ul class="tsd-legend">
211
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
212
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
223
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
224
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
213
225
  </ul>
214
226
  <ul class="tsd-legend">
215
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
227
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
216
228
  </ul>
217
229
  </div>
218
230
  </div>
package/docs/interfaces/{item.html → datatypes.Item.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="item.html">Item</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.Item.html">Item</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface Item</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="item.html#id" class="tsd-kind-icon">id</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Item.html#id" class="tsd-kind-icon">id</a></li>
84
87
  </ul>
85
88
  </section>
86
89
  </div>
@@ -94,7 +97,7 @@
94
97
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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#L5">types.ts:5</a></li>
100
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L5">datatypes.ts:5</a></li>
98
101
  </ul>
99
102
  </aside>
100
103
  <div class="tsd-comment tsd-typography">
@@ -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="item.html" class="tsd-kind-icon">Item</a>
132
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
133
+ <a href="datatypes.Item.html" class="tsd-kind-icon">Item</a>
122
134
  <ul>
123
135
  <li class=" tsd-kind-property tsd-parent-kind-interface">
124
- <a href="item.html#id" class="tsd-kind-icon">id</a>
136
+ <a href="datatypes.Item.html#id" class="tsd-kind-icon">id</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/{paging.html → datatypes.Paging.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="paging.html">Paging</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.Paging.html">Paging</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface Paging</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="paging.html#before_id" class="tsd-kind-icon">before_<wbr>id</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="paging.html#limit" class="tsd-kind-icon">limit</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Paging.html#beforeId" class="tsd-kind-icon">before<wbr>Id</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Paging.html#limit" class="tsd-kind-icon">limit</a></li>
85
88
  </ul>
86
89
  </section>
87
90
  </div>
@@ -90,12 +93,12 @@
90
93
  <section class="tsd-panel-group tsd-member-group ">
91
94
  <h2>Properties</h2>
92
95
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
93
- <a name="before_id" class="tsd-anchor"></a>
94
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> before_<wbr>id</h3>
95
- <div class="tsd-signature tsd-kind-icon">before_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
96
+ <a name="beforeId" class="tsd-anchor"></a>
97
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> before<wbr>Id</h3>
98
+ <div class="tsd-signature tsd-kind-icon">before<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
96
99
  <aside class="tsd-sources">
97
100
  <ul>
98
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L9">types.ts:9</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L9">datatypes.ts:9</a></li>
99
102
  </ul>
100
103
  </aside>
101
104
  </section>
@@ -105,7 +108,7 @@
105
108
  <div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
106
109
  <aside class="tsd-sources">
107
110
  <ul>
108
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L10">types.ts:10</a></li>
111
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L10">datatypes.ts:10</a></li>
109
112
  </ul>
110
113
  </aside>
111
114
  </section>
@@ -115,7 +118,16 @@
115
118
  <nav class="tsd-navigation primary">
116
119
  <ul>
117
120
  <li class=" ">
118
- <a href="../modules.html">Exports</a>
121
+ <a href="../modules.html">Modules</a>
122
+ </li>
123
+ <li class=" tsd-kind-module">
124
+ <a href="../modules/client.html">client</a>
125
+ </li>
126
+ <li class="current tsd-kind-module">
127
+ <a href="../modules/datatypes.html">datatypes</a>
128
+ </li>
129
+ <li class=" tsd-kind-module">
130
+ <a href="../modules/services.html">services</a>
119
131
  </li>
120
132
  </ul>
121
133
  </nav>
@@ -123,14 +135,14 @@
123
135
  <ul class="before-current">
124
136
  </ul>
125
137
  <ul class="current">
126
- <li class="current tsd-kind-interface">
127
- <a href="paging.html" class="tsd-kind-icon">Paging</a>
138
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
139
+ <a href="datatypes.Paging.html" class="tsd-kind-icon">Paging</a>
128
140
  <ul>
129
141
  <li class=" tsd-kind-property tsd-parent-kind-interface">
130
- <a href="paging.html#before_id" class="tsd-kind-icon">before_<wbr>id</a>
142
+ <a href="datatypes.Paging.html#beforeId" class="tsd-kind-icon">before<wbr>Id</a>
131
143
  </li>
132
144
  <li class=" tsd-kind-property tsd-parent-kind-interface">
133
- <a href="paging.html#limit" class="tsd-kind-icon">limit</a>
145
+ <a href="datatypes.Paging.html#limit" class="tsd-kind-icon">limit</a>
134
146
  </li>
135
147
  </ul>
136
148
  </li>
@@ -146,11 +158,11 @@
146
158
  <h2>Legend</h2>
147
159
  <div class="tsd-legend-group">
148
160
  <ul class="tsd-legend">
149
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
150
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
161
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
162
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
151
163
  </ul>
152
164
  <ul class="tsd-legend">
153
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
165
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
154
166
  </ul>
155
167
  </div>
156
168
  </div>