@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/{endpointoauth.html → datatypes.EndpointOAuth.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="endpointoauth.html">EndpointOAuth</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointOAuth.html">EndpointOAuth</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointOAuth</h1>
@@ -80,13 +83,13 @@
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="endpointoauth.html#auth_check_interval" class="tsd-kind-icon">auth_<wbr>check_<wbr>interval</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoauth.html#cookie_prefix" class="tsd-kind-icon">cookie_<wbr>prefix</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoauth.html#enabled" class="tsd-kind-icon">enabled</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoauth.html#inactivity_timeout" class="tsd-kind-icon">inactivity_<wbr>timeout</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoauth.html#maximum_duration" class="tsd-kind-icon">maximum_<wbr>duration</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoauth.html#options_passthrough" class="tsd-kind-icon">options_<wbr>passthrough</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoauth.html#provider" class="tsd-kind-icon">provider</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuth.html#authCheckInterval" class="tsd-kind-icon">auth<wbr>Check<wbr>Interval</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuth.html#cookiePrefix" class="tsd-kind-icon">cookie<wbr>Prefix</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuth.html#enabled" class="tsd-kind-icon">enabled</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuth.html#inactivityTimeout" class="tsd-kind-icon">inactivity<wbr>Timeout</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuth.html#maximumDuration" class="tsd-kind-icon">maximum<wbr>Duration</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuth.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuth.html#provider" class="tsd-kind-icon">provider</a></li>
90
93
  </ul>
91
94
  </section>
92
95
  </div>
@@ -95,12 +98,12 @@
95
98
  <section class="tsd-panel-group tsd-member-group ">
96
99
  <h2>Properties</h2>
97
100
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
98
- <a name="auth_check_interval" class="tsd-anchor"></a>
99
- <h3>auth_<wbr>check_<wbr>interval</h3>
100
- <div class="tsd-signature tsd-kind-icon">auth_<wbr>check_<wbr>interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
101
+ <a name="authCheckInterval" class="tsd-anchor"></a>
102
+ <h3>auth<wbr>Check<wbr>Interval</h3>
103
+ <div class="tsd-signature tsd-kind-icon">auth<wbr>Check<wbr>Interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
101
104
  <aside class="tsd-sources">
102
105
  <ul>
103
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L595">types.ts:595</a></li>
106
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L524">datatypes.ts:524</a></li>
104
107
  </ul>
105
108
  </aside>
106
109
  <div class="tsd-comment tsd-typography">
@@ -110,12 +113,12 @@
110
113
  </div>
111
114
  </section>
112
115
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
113
- <a name="cookie_prefix" class="tsd-anchor"></a>
114
- <h3>cookie_<wbr>prefix</h3>
115
- <div class="tsd-signature tsd-kind-icon">cookie_<wbr>prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
116
+ <a name="cookiePrefix" class="tsd-anchor"></a>
117
+ <h3>cookie<wbr>Prefix</h3>
118
+ <div class="tsd-signature tsd-kind-icon">cookie<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
116
119
  <aside class="tsd-sources">
117
120
  <ul>
118
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L589">types.ts:589</a></li>
121
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L518">datatypes.ts:518</a></li>
119
122
  </ul>
120
123
  </aside>
121
124
  <div class="tsd-comment tsd-typography">
@@ -130,22 +133,22 @@
130
133
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
131
134
  <aside class="tsd-sources">
132
135
  <ul>
133
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L583">types.ts:583</a></li>
136
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L512">datatypes.ts:512</a></li>
134
137
  </ul>
135
138
  </aside>
136
139
  <div class="tsd-comment tsd-typography">
137
140
  <div class="lead">
138
- <p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
141
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
139
142
  </div>
140
143
  </div>
141
144
  </section>
142
145
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
143
- <a name="inactivity_timeout" class="tsd-anchor"></a>
144
- <h3>inactivity_<wbr>timeout</h3>
145
- <div class="tsd-signature tsd-kind-icon">inactivity_<wbr>timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
146
+ <a name="inactivityTimeout" class="tsd-anchor"></a>
147
+ <h3>inactivity<wbr>Timeout</h3>
148
+ <div class="tsd-signature tsd-kind-icon">inactivity<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
146
149
  <aside class="tsd-sources">
147
150
  <ul>
148
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L591">types.ts:591</a></li>
151
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L520">datatypes.ts:520</a></li>
149
152
  </ul>
150
153
  </aside>
151
154
  <div class="tsd-comment tsd-typography">
@@ -155,12 +158,12 @@
155
158
  </div>
156
159
  </section>
157
160
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
158
- <a name="maximum_duration" class="tsd-anchor"></a>
159
- <h3>maximum_<wbr>duration</h3>
160
- <div class="tsd-signature tsd-kind-icon">maximum_<wbr>duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
161
+ <a name="maximumDuration" class="tsd-anchor"></a>
162
+ <h3>maximum<wbr>Duration</h3>
163
+ <div class="tsd-signature tsd-kind-icon">maximum<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
161
164
  <aside class="tsd-sources">
162
165
  <ul>
163
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L593">types.ts:593</a></li>
166
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L522">datatypes.ts:522</a></li>
164
167
  </ul>
165
168
  </aside>
166
169
  <div class="tsd-comment tsd-typography">
@@ -170,12 +173,12 @@
170
173
  </div>
171
174
  </section>
172
175
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
173
- <a name="options_passthrough" class="tsd-anchor"></a>
174
- <h3>options_<wbr>passthrough</h3>
175
- <div class="tsd-signature tsd-kind-icon">options_<wbr>passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
176
+ <a name="optionsPassthrough" class="tsd-anchor"></a>
177
+ <h3>options<wbr>Passthrough</h3>
178
+ <div class="tsd-signature tsd-kind-icon">options<wbr>Passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
176
179
  <aside class="tsd-sources">
177
180
  <ul>
178
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L587">types.ts:587</a></li>
181
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L516">datatypes.ts:516</a></li>
179
182
  </ul>
180
183
  </aside>
181
184
  <div class="tsd-comment tsd-typography">
@@ -187,10 +190,10 @@
187
190
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
188
191
  <a name="provider" class="tsd-anchor"></a>
189
192
  <h3>provider</h3>
190
- <div class="tsd-signature tsd-kind-icon">provider<span class="tsd-signature-symbol">:</span> <a href="endpointoauthprovider.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthProvider</a></div>
193
+ <div class="tsd-signature tsd-kind-icon">provider<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthProvider</a></div>
191
194
  <aside class="tsd-sources">
192
195
  <ul>
193
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L585">types.ts:585</a></li>
196
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L514">datatypes.ts:514</a></li>
194
197
  </ul>
195
198
  </aside>
196
199
  <div class="tsd-comment tsd-typography">
@@ -205,7 +208,16 @@
205
208
  <nav class="tsd-navigation primary">
206
209
  <ul>
207
210
  <li class=" ">
208
- <a href="../modules.html">Exports</a>
211
+ <a href="../modules.html">Modules</a>
212
+ </li>
213
+ <li class=" tsd-kind-module">
214
+ <a href="../modules/client.html">client</a>
215
+ </li>
216
+ <li class="current tsd-kind-module">
217
+ <a href="../modules/datatypes.html">datatypes</a>
218
+ </li>
219
+ <li class=" tsd-kind-module">
220
+ <a href="../modules/services.html">services</a>
209
221
  </li>
210
222
  </ul>
211
223
  </nav>
@@ -213,29 +225,29 @@
213
225
  <ul class="before-current">
214
226
  </ul>
215
227
  <ul class="current">
216
- <li class="current tsd-kind-interface">
217
- <a href="endpointoauth.html" class="tsd-kind-icon">EndpointOAuth</a>
228
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
229
+ <a href="datatypes.EndpointOAuth.html" class="tsd-kind-icon">EndpointOAuth</a>
218
230
  <ul>
219
231
  <li class=" tsd-kind-property tsd-parent-kind-interface">
220
- <a href="endpointoauth.html#auth_check_interval" class="tsd-kind-icon">auth_<wbr>check_<wbr>interval</a>
232
+ <a href="datatypes.EndpointOAuth.html#authCheckInterval" class="tsd-kind-icon">auth<wbr>Check<wbr>Interval</a>
221
233
  </li>
222
234
  <li class=" tsd-kind-property tsd-parent-kind-interface">
223
- <a href="endpointoauth.html#cookie_prefix" class="tsd-kind-icon">cookie_<wbr>prefix</a>
235
+ <a href="datatypes.EndpointOAuth.html#cookiePrefix" class="tsd-kind-icon">cookie<wbr>Prefix</a>
224
236
  </li>
225
237
  <li class=" tsd-kind-property tsd-parent-kind-interface">
226
- <a href="endpointoauth.html#enabled" class="tsd-kind-icon">enabled</a>
238
+ <a href="datatypes.EndpointOAuth.html#enabled" class="tsd-kind-icon">enabled</a>
227
239
  </li>
228
240
  <li class=" tsd-kind-property tsd-parent-kind-interface">
229
- <a href="endpointoauth.html#inactivity_timeout" class="tsd-kind-icon">inactivity_<wbr>timeout</a>
241
+ <a href="datatypes.EndpointOAuth.html#inactivityTimeout" class="tsd-kind-icon">inactivity<wbr>Timeout</a>
230
242
  </li>
231
243
  <li class=" tsd-kind-property tsd-parent-kind-interface">
232
- <a href="endpointoauth.html#maximum_duration" class="tsd-kind-icon">maximum_<wbr>duration</a>
244
+ <a href="datatypes.EndpointOAuth.html#maximumDuration" class="tsd-kind-icon">maximum<wbr>Duration</a>
233
245
  </li>
234
246
  <li class=" tsd-kind-property tsd-parent-kind-interface">
235
- <a href="endpointoauth.html#options_passthrough" class="tsd-kind-icon">options_<wbr>passthrough</a>
247
+ <a href="datatypes.EndpointOAuth.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a>
236
248
  </li>
237
249
  <li class=" tsd-kind-property tsd-parent-kind-interface">
238
- <a href="endpointoauth.html#provider" class="tsd-kind-icon">provider</a>
250
+ <a href="datatypes.EndpointOAuth.html#provider" class="tsd-kind-icon">provider</a>
239
251
  </li>
240
252
  </ul>
241
253
  </li>
@@ -251,11 +263,11 @@
251
263
  <h2>Legend</h2>
252
264
  <div class="tsd-legend-group">
253
265
  <ul class="tsd-legend">
254
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
255
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
266
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
267
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
256
268
  </ul>
257
269
  <ul class="tsd-legend">
258
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
270
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
259
271
  </ul>
260
272
  </div>
261
273
  </div>
package/docs/interfaces/{endpointoauthfacebook.html → datatypes.EndpointOAuthFacebook.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="endpointoauthfacebook.html">EndpointOAuthFacebook</a>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EndpointOAuthFacebook.html">EndpointOAuthFacebook</a>
59
62
  </li>
60
63
  </ul>
61
64
  <h1>Interface EndpointOAuthFacebook</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="endpointoauthfacebook.html#client_id" class="tsd-kind-icon">client_<wbr>id</a></li>
84
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoauthfacebook.html#client_secret" class="tsd-kind-icon">client_<wbr>secret</a></li>
85
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoauthfacebook.html#email_addresses" class="tsd-kind-icon">email_<wbr>addresses</a></li>
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoauthfacebook.html#email_domains" class="tsd-kind-icon">email_<wbr>domains</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="endpointoauthfacebook.html#scopes" class="tsd-kind-icon">scopes</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthFacebook.html#clientId" class="tsd-kind-icon">client<wbr>Id</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthFacebook.html#clientSecret" class="tsd-kind-icon">client<wbr>Secret</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthFacebook.html#emailAddresses" class="tsd-kind-icon">email<wbr>Addresses</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthFacebook.html#emailDomains" class="tsd-kind-icon">email<wbr>Domains</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthFacebook.html#scopes" class="tsd-kind-icon">scopes</a></li>
88
91
  </ul>
89
92
  </section>
90
93
  </div>
@@ -93,12 +96,12 @@
93
96
  <section class="tsd-panel-group tsd-member-group ">
94
97
  <h2>Properties</h2>
95
98
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
96
- <a name="client_id" class="tsd-anchor"></a>
97
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> client_<wbr>id</h3>
98
- <div class="tsd-signature tsd-kind-icon">client_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
+ <a name="clientId" class="tsd-anchor"></a>
100
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> client<wbr>Id</h3>
101
+ <div class="tsd-signature tsd-kind-icon">client<wbr>Id<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#L628">types.ts:628</a></li>
104
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L557">datatypes.ts:557</a></li>
102
105
  </ul>
103
106
  </aside>
104
107
  <div class="tsd-comment tsd-typography">
@@ -108,27 +111,27 @@
108
111
  </div>
109
112
  </section>
110
113
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
111
- <a name="client_secret" class="tsd-anchor"></a>
112
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> client_<wbr>secret</h3>
113
- <div class="tsd-signature tsd-kind-icon">client_<wbr>secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
114
+ <a name="clientSecret" class="tsd-anchor"></a>
115
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> client<wbr>Secret</h3>
116
+ <div class="tsd-signature tsd-kind-icon">client<wbr>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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#L630">types.ts:630</a></li>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L559">datatypes.ts:559</a></li>
117
120
  </ul>
118
121
  </aside>
119
122
  <div class="tsd-comment tsd-typography">
120
123
  <div class="lead">
121
- <p>the OAuth app client secret. retrieve if from the identity provider&#39;s dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for client_id.</p>
124
+ <p>the OAuth app client secret. retrieve if from the identity provider&#39;s dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for <code>client_id</code>.</p>
122
125
  </div>
123
126
  </div>
124
127
  </section>
125
128
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
126
- <a name="email_addresses" class="tsd-anchor"></a>
127
- <h3>email_<wbr>addresses</h3>
128
- <div class="tsd-signature tsd-kind-icon">email_<wbr>addresses<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
129
+ <a name="emailAddresses" class="tsd-anchor"></a>
130
+ <h3>email<wbr>Addresses</h3>
131
+ <div class="tsd-signature tsd-kind-icon">email<wbr>Addresses<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#L634">types.ts:634</a></li>
134
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L563">datatypes.ts:563</a></li>
132
135
  </ul>
133
136
  </aside>
134
137
  <div class="tsd-comment tsd-typography">
@@ -138,12 +141,12 @@
138
141
  </div>
139
142
  </section>
140
143
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
141
- <a name="email_domains" class="tsd-anchor"></a>
142
- <h3>email_<wbr>domains</h3>
143
- <div class="tsd-signature tsd-kind-icon">email_<wbr>domains<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
144
+ <a name="emailDomains" class="tsd-anchor"></a>
145
+ <h3>email<wbr>Domains</h3>
146
+ <div class="tsd-signature tsd-kind-icon">email<wbr>Domains<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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#L636">types.ts:636</a></li>
149
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L565">datatypes.ts:565</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">scopes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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#L632">types.ts:632</a></li>
164
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L561">datatypes.ts:561</a></li>
162
165
  </ul>
163
166
  </aside>
164
167
  <div class="tsd-comment tsd-typography">
165
168
  <div class="lead">
166
- <p>a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)</p>
169
+ <p>a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both <code>client_id</code> and <code>client_secret</code> to set scopes)</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="endpointoauthfacebook.html" class="tsd-kind-icon">EndpointOAuth<wbr>Facebook</a>
196
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
197
+ <a href="datatypes.EndpointOAuthFacebook.html" class="tsd-kind-icon">EndpointOAuth<wbr>Facebook</a>
186
198
  <ul>
187
199
  <li class=" tsd-kind-property tsd-parent-kind-interface">
188
- <a href="endpointoauthfacebook.html#client_id" class="tsd-kind-icon">client_<wbr>id</a>
200
+ <a href="datatypes.EndpointOAuthFacebook.html#clientId" class="tsd-kind-icon">client<wbr>Id</a>
189
201
  </li>
190
202
  <li class=" tsd-kind-property tsd-parent-kind-interface">
191
- <a href="endpointoauthfacebook.html#client_secret" class="tsd-kind-icon">client_<wbr>secret</a>
203
+ <a href="datatypes.EndpointOAuthFacebook.html#clientSecret" class="tsd-kind-icon">client<wbr>Secret</a>
192
204
  </li>
193
205
  <li class=" tsd-kind-property tsd-parent-kind-interface">
194
- <a href="endpointoauthfacebook.html#email_addresses" class="tsd-kind-icon">email_<wbr>addresses</a>
206
+ <a href="datatypes.EndpointOAuthFacebook.html#emailAddresses" class="tsd-kind-icon">email<wbr>Addresses</a>
195
207
  </li>
196
208
  <li class=" tsd-kind-property tsd-parent-kind-interface">
197
- <a href="endpointoauthfacebook.html#email_domains" class="tsd-kind-icon">email_<wbr>domains</a>
209
+ <a href="datatypes.EndpointOAuthFacebook.html#emailDomains" class="tsd-kind-icon">email<wbr>Domains</a>
198
210
  </li>
199
211
  <li class=" tsd-kind-property tsd-parent-kind-interface">
200
- <a href="endpointoauthfacebook.html#scopes" class="tsd-kind-icon">scopes</a>
212
+ <a href="datatypes.EndpointOAuthFacebook.html#scopes" class="tsd-kind-icon">scopes</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>