@ngrok/ngrok-api 0.0.9 → 0.3.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 (218) hide show
  1. package/.eslintrc.js +4 -1
  2. package/CHANGELOG.md +34 -0
  3. package/README.md +148 -2
  4. package/docs/CNAME +1 -0
  5. package/docs/assets/css/main.css +2660 -0
  6. package/docs/assets/images/icons.png +0 -0
  7. package/docs/assets/images/icons@2x.png +0 -0
  8. package/docs/assets/images/widgets.png +0 -0
  9. package/docs/assets/images/widgets@2x.png +0 -0
  10. package/docs/assets/js/main.js +248 -0
  11. package/docs/assets/js/search.js +1 -0
  12. package/docs/classes/client.Ngrok.html +681 -0
  13. package/docs/classes/services.APIKeys.html +453 -0
  14. package/docs/classes/services.AbuseReports.html +360 -0
  15. package/docs/classes/services.AgentIngresses.html +442 -0
  16. package/docs/classes/services.CertificateAuthorities.html +453 -0
  17. package/docs/classes/services.Credentials.html +452 -0
  18. package/docs/classes/services.EndpointCircuitBreakerModule.html +369 -0
  19. package/docs/classes/services.EndpointCompressionModule.html +369 -0
  20. package/docs/classes/services.EndpointConfigurations.html +451 -0
  21. package/docs/classes/services.EndpointIPPolicyModule.html +369 -0
  22. package/docs/classes/services.EndpointLoggingModule.html +369 -0
  23. package/docs/classes/services.EndpointMutualTLSModule.html +369 -0
  24. package/docs/classes/services.EndpointOAuthModule.html +369 -0
  25. package/docs/classes/services.EndpointOIDCModule.html +369 -0
  26. package/docs/classes/services.EndpointRequestHeadersModule.html +369 -0
  27. package/docs/classes/services.EndpointResponseHeadersModule.html +369 -0
  28. package/docs/classes/services.EndpointSAMLModule.html +369 -0
  29. package/docs/classes/services.EndpointTLSTerminationModule.html +369 -0
  30. package/docs/classes/services.EndpointWebhookValidationModule.html +369 -0
  31. package/docs/classes/services.EventDestinations.html +442 -0
  32. package/docs/classes/services.EventSources.html +448 -0
  33. package/docs/classes/services.EventStreams.html +442 -0
  34. package/docs/classes/services.EventSubscriptions.html +442 -0
  35. package/docs/classes/services.IPPolicies.html +452 -0
  36. package/docs/classes/services.IPPolicyRules.html +450 -0
  37. package/docs/classes/services.IPRestrictions.html +454 -0
  38. package/docs/classes/services.ReservedAddrs.html +483 -0
  39. package/docs/classes/services.ReservedDomains.html +580 -0
  40. package/docs/classes/services.SSHCertificateAuthorities.html +450 -0
  41. package/docs/classes/services.SSHCredentials.html +450 -0
  42. package/docs/classes/services.SSHHostCertificates.html +451 -0
  43. package/docs/classes/services.SSHUserCertificates.html +451 -0
  44. package/docs/classes/services.TLSCertificates.html +453 -0
  45. package/docs/classes/services.TunnelSessions.html +451 -0
  46. package/docs/classes/services.Tunnels.html +322 -0
  47. package/docs/index.html +239 -0
  48. package/docs/interfaces/client.NgrokConfig.html +179 -0
  49. package/docs/interfaces/datatypes.APIKey.html +262 -0
  50. package/docs/interfaces/datatypes.APIKeyCreate.html +186 -0
  51. package/docs/interfaces/datatypes.APIKeyList.html +205 -0
  52. package/docs/interfaces/datatypes.APIKeyUpdate.html +200 -0
  53. package/docs/interfaces/datatypes.AWSAuth.html +186 -0
  54. package/docs/interfaces/datatypes.AWSCredentials.html +186 -0
  55. package/docs/interfaces/datatypes.AWSRole.html +167 -0
  56. package/docs/interfaces/datatypes.AbuseReport.html +281 -0
  57. package/docs/interfaces/datatypes.AbuseReportCreate.html +186 -0
  58. package/docs/interfaces/datatypes.AbuseReportHostname.html +186 -0
  59. package/docs/interfaces/datatypes.AgentIngress.html +300 -0
  60. package/docs/interfaces/datatypes.AgentIngressCreate.html +205 -0
  61. package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
  62. package/docs/interfaces/datatypes.AgentIngressUpdate.html +200 -0
  63. package/docs/interfaces/datatypes.CertificateAuthority.html +357 -0
  64. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +205 -0
  65. package/docs/interfaces/datatypes.CertificateAuthorityList.html +205 -0
  66. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +200 -0
  67. package/docs/interfaces/datatypes.Credential.html +281 -0
  68. package/docs/interfaces/datatypes.CredentialCreate.html +205 -0
  69. package/docs/interfaces/datatypes.CredentialList.html +205 -0
  70. package/docs/interfaces/datatypes.CredentialUpdate.html +219 -0
  71. package/docs/interfaces/datatypes.Empty.html +130 -0
  72. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +262 -0
  73. package/docs/interfaces/datatypes.EndpointCircuitBreakerReplace.html +176 -0
  74. package/docs/interfaces/datatypes.EndpointCompression.html +167 -0
  75. package/docs/interfaces/datatypes.EndpointCompressionReplace.html +176 -0
  76. package/docs/interfaces/datatypes.EndpointConfiguration.html +490 -0
  77. package/docs/interfaces/datatypes.EndpointConfigurationCreate.html +433 -0
  78. package/docs/interfaces/datatypes.EndpointConfigurationList.html +205 -0
  79. package/docs/interfaces/datatypes.EndpointConfigurationUpdate.html +433 -0
  80. package/docs/interfaces/datatypes.EndpointIPPolicy.html +181 -0
  81. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +186 -0
  82. package/docs/interfaces/datatypes.EndpointIPPolicyReplace.html +176 -0
  83. package/docs/interfaces/datatypes.EndpointLogging.html +186 -0
  84. package/docs/interfaces/datatypes.EndpointLoggingMutate.html +186 -0
  85. package/docs/interfaces/datatypes.EndpointLoggingReplace.html +176 -0
  86. package/docs/interfaces/datatypes.EndpointMutualTLS.html +186 -0
  87. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +186 -0
  88. package/docs/interfaces/datatypes.EndpointMutualTLSReplace.html +176 -0
  89. package/docs/interfaces/datatypes.EndpointOAuth.html +281 -0
  90. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +243 -0
  91. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +281 -0
  92. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +243 -0
  93. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +243 -0
  94. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +224 -0
  95. package/docs/interfaces/datatypes.EndpointOAuthReplace.html +176 -0
  96. package/docs/interfaces/datatypes.EndpointOIDC.html +319 -0
  97. package/docs/interfaces/datatypes.EndpointOIDCReplace.html +176 -0
  98. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +205 -0
  99. package/docs/interfaces/datatypes.EndpointRequestHeadersReplace.html +176 -0
  100. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +205 -0
  101. package/docs/interfaces/datatypes.EndpointResponseHeadersReplace.html +176 -0
  102. package/docs/interfaces/datatypes.EndpointSAML.html +433 -0
  103. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +338 -0
  104. package/docs/interfaces/datatypes.EndpointSAMLReplace.html +176 -0
  105. package/docs/interfaces/datatypes.EndpointTLSTermination.html +205 -0
  106. package/docs/interfaces/datatypes.EndpointTLSTerminationReplace.html +176 -0
  107. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +205 -0
  108. package/docs/interfaces/datatypes.EndpointWebhookValidationReplace.html +176 -0
  109. package/docs/interfaces/datatypes.Error.html +204 -0
  110. package/docs/interfaces/datatypes.EventDestination.html +281 -0
  111. package/docs/interfaces/datatypes.EventDestinationCreate.html +224 -0
  112. package/docs/interfaces/datatypes.EventDestinationList.html +205 -0
  113. package/docs/interfaces/datatypes.EventDestinationUpdate.html +243 -0
  114. package/docs/interfaces/datatypes.EventSource.html +186 -0
  115. package/docs/interfaces/datatypes.EventSourceCreate.html +186 -0
  116. package/docs/interfaces/datatypes.EventSourceItem.html +193 -0
  117. package/docs/interfaces/datatypes.EventSourceList.html +186 -0
  118. package/docs/interfaces/datatypes.EventSourcePaging.html +174 -0
  119. package/docs/interfaces/datatypes.EventSourceReplace.html +167 -0
  120. package/docs/interfaces/datatypes.EventSourceUpdate.html +186 -0
  121. package/docs/interfaces/datatypes.EventStream.html +319 -0
  122. package/docs/interfaces/datatypes.EventStreamCreate.html +262 -0
  123. package/docs/interfaces/datatypes.EventStreamList.html +205 -0
  124. package/docs/interfaces/datatypes.EventStreamUpdate.html +262 -0
  125. package/docs/interfaces/datatypes.EventSubscription.html +281 -0
  126. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +224 -0
  127. package/docs/interfaces/datatypes.EventSubscriptionList.html +205 -0
  128. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +243 -0
  129. package/docs/interfaces/datatypes.EventTarget.html +205 -0
  130. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +186 -0
  131. package/docs/interfaces/datatypes.EventTargetFirehose.html +186 -0
  132. package/docs/interfaces/datatypes.EventTargetKinesis.html +186 -0
  133. package/docs/interfaces/datatypes.IPPolicy.html +262 -0
  134. package/docs/interfaces/datatypes.IPPolicyCreate.html +205 -0
  135. package/docs/interfaces/datatypes.IPPolicyList.html +205 -0
  136. package/docs/interfaces/datatypes.IPPolicyRule.html +281 -0
  137. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +224 -0
  138. package/docs/interfaces/datatypes.IPPolicyRuleList.html +205 -0
  139. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +219 -0
  140. package/docs/interfaces/datatypes.IPPolicyUpdate.html +200 -0
  141. package/docs/interfaces/datatypes.IPRestriction.html +300 -0
  142. package/docs/interfaces/datatypes.IPRestrictionCreate.html +243 -0
  143. package/docs/interfaces/datatypes.IPRestrictionList.html +205 -0
  144. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +238 -0
  145. package/docs/interfaces/datatypes.Item.html +167 -0
  146. package/docs/interfaces/datatypes.Paging.html +176 -0
  147. package/docs/interfaces/datatypes.Ref.html +186 -0
  148. package/docs/interfaces/datatypes.ReservedAddr.html +300 -0
  149. package/docs/interfaces/datatypes.ReservedAddrCreate.html +224 -0
  150. package/docs/interfaces/datatypes.ReservedAddrList.html +205 -0
  151. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +219 -0
  152. package/docs/interfaces/datatypes.ReservedDomain.html +414 -0
  153. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +224 -0
  154. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +186 -0
  155. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +186 -0
  156. package/docs/interfaces/datatypes.ReservedDomainCreate.html +300 -0
  157. package/docs/interfaces/datatypes.ReservedDomainList.html +205 -0
  158. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +276 -0
  159. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +281 -0
  160. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +243 -0
  161. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +205 -0
  162. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +200 -0
  163. package/docs/interfaces/datatypes.SSHCredential.html +281 -0
  164. package/docs/interfaces/datatypes.SSHCredentialCreate.html +224 -0
  165. package/docs/interfaces/datatypes.SSHCredentialList.html +205 -0
  166. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +219 -0
  167. package/docs/interfaces/datatypes.SSHHostCertificate.html +376 -0
  168. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +281 -0
  169. package/docs/interfaces/datatypes.SSHHostCertificateList.html +205 -0
  170. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +200 -0
  171. package/docs/interfaces/datatypes.SSHUserCertificate.html +414 -0
  172. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +319 -0
  173. package/docs/interfaces/datatypes.SSHUserCertificateList.html +205 -0
  174. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +200 -0
  175. package/docs/interfaces/datatypes.TLSCertificate.html +547 -0
  176. package/docs/interfaces/datatypes.TLSCertificateCreate.html +224 -0
  177. package/docs/interfaces/datatypes.TLSCertificateList.html +205 -0
  178. package/docs/interfaces/datatypes.TLSCertificateSANs.html +186 -0
  179. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +200 -0
  180. package/docs/interfaces/datatypes.Tunnel.html +281 -0
  181. package/docs/interfaces/datatypes.TunnelList.html +205 -0
  182. package/docs/interfaces/datatypes.TunnelSession.html +338 -0
  183. package/docs/interfaces/datatypes.TunnelSessionList.html +205 -0
  184. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +162 -0
  185. package/docs/modules/client.html +137 -0
  186. package/docs/modules/datatypes.html +668 -0
  187. package/docs/modules/services.html +260 -0
  188. package/docs/modules.html +119 -0
  189. package/lib/client.d.ts +145 -0
  190. package/lib/client.d.ts.map +1 -0
  191. package/lib/client.js +102 -0
  192. package/lib/client.js.map +1 -0
  193. package/lib/{types.d.ts → datatypes.d.ts} +620 -816
  194. package/lib/datatypes.d.ts.map +1 -0
  195. package/lib/{types.js → datatypes.js} +1 -1
  196. package/lib/datatypes.js.map +1 -0
  197. package/lib/index.d.ts +3 -314
  198. package/lib/index.d.ts.map +1 -0
  199. package/lib/index.js +25 -887
  200. package/lib/index.js.map +1 -1
  201. package/lib/services.d.ts +773 -0
  202. package/lib/services.d.ts.map +1 -0
  203. package/lib/services.js +2761 -0
  204. package/lib/services.js.map +1 -0
  205. package/lib/util.d.ts +5 -0
  206. package/lib/util.d.ts.map +1 -0
  207. package/lib/util.js +53 -0
  208. package/lib/util.js.map +1 -0
  209. package/package.json +12 -3
  210. package/src/client.ts +265 -0
  211. package/src/{types.ts → datatypes.ts} +648 -869
  212. package/src/index.ts +2 -616
  213. package/src/services.ts +2560 -0
  214. package/src/util.ts +48 -0
  215. package/test/apikey.test.js +44 -30
  216. package/test/endpointConfigurations.test.js +38 -34
  217. package/tsconfig.json +17 -7
  218. package/lib/types.js.map +0 -1
package/docs/modules/services.html ADDED
@@ -0,0 +1,260 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>services | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="services.html">services</a>
59
+ </li>
60
+ </ul>
61
+ <h1>Module services</h1>
62
+ </div>
63
+ </div>
64
+ </header>
65
+ <div class="container container-main">
66
+ <div class="row">
67
+ <div class="col-8 col-content">
68
+ <section class="tsd-panel-group tsd-index-group">
69
+ <h2>Index</h2>
70
+ <section class="tsd-panel tsd-index-panel">
71
+ <div class="tsd-index-content">
72
+ <section class="tsd-index-section ">
73
+ <h3>Classes</h3>
74
+ <ul class="tsd-index-list">
75
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.APIKeys.html" class="tsd-kind-icon">APIKeys</a></li>
76
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a></li>
77
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.AgentIngresses.html" class="tsd-kind-icon">Agent<wbr>Ingresses</a></li>
78
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a></li>
79
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.Credentials.html" class="tsd-kind-icon">Credentials</a></li>
80
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a></li>
81
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EndpointCompressionModule.html" class="tsd-kind-icon">Endpoint<wbr>Compression<wbr>Module</a></li>
82
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EndpointConfigurations.html" class="tsd-kind-icon">Endpoint<wbr>Configurations</a></li>
83
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EndpointIPPolicyModule.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Module</a></li>
84
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EndpointLoggingModule.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Module</a></li>
85
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EndpointMutualTLSModule.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSModule</a></li>
86
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EndpointOAuthModule.html" class="tsd-kind-icon">EndpointOAuth<wbr>Module</a></li>
87
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EndpointOIDCModule.html" class="tsd-kind-icon">EndpointOIDCModule</a></li>
88
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EndpointRequestHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers<wbr>Module</a></li>
89
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EndpointResponseHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers<wbr>Module</a></li>
90
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EndpointSAMLModule.html" class="tsd-kind-icon">EndpointSAMLModule</a></li>
91
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EndpointTLSTerminationModule.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>Module</a></li>
92
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EndpointWebhookValidationModule.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation<wbr>Module</a></li>
93
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EventDestinations.html" class="tsd-kind-icon">Event<wbr>Destinations</a></li>
94
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EventSources.html" class="tsd-kind-icon">Event<wbr>Sources</a></li>
95
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EventStreams.html" class="tsd-kind-icon">Event<wbr>Streams</a></li>
96
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EventSubscriptions.html" class="tsd-kind-icon">Event<wbr>Subscriptions</a></li>
97
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a></li>
98
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a></li>
99
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a></li>
100
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a></li>
101
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a></li>
102
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a></li>
103
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a></li>
104
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.SSHHostCertificates.html" class="tsd-kind-icon">SSHHost<wbr>Certificates</a></li>
105
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a></li>
106
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a></li>
107
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a></li>
108
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.Tunnels.html" class="tsd-kind-icon">Tunnels</a></li>
109
+ </ul>
110
+ </section>
111
+ </div>
112
+ </section>
113
+ </section>
114
+ </div>
115
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
116
+ <nav class="tsd-navigation primary">
117
+ <ul>
118
+ <li class=" ">
119
+ <a href="../modules.html">Modules</a>
120
+ </li>
121
+ <li class=" tsd-kind-module">
122
+ <a href="client.html">client</a>
123
+ </li>
124
+ <li class=" tsd-kind-module">
125
+ <a href="datatypes.html">datatypes</a>
126
+ </li>
127
+ <li class="current tsd-kind-module">
128
+ <a href="services.html">services</a>
129
+ </li>
130
+ </ul>
131
+ </nav>
132
+ <nav class="tsd-navigation secondary menu-sticky">
133
+ <ul class="before-current">
134
+ <li class=" tsd-kind-class tsd-parent-kind-module">
135
+ <a href="../classes/services.APIKeys.html" class="tsd-kind-icon">APIKeys</a>
136
+ </li>
137
+ <li class=" tsd-kind-class tsd-parent-kind-module">
138
+ <a href="../classes/services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
139
+ </li>
140
+ <li class=" tsd-kind-class tsd-parent-kind-module">
141
+ <a href="../classes/services.AgentIngresses.html" class="tsd-kind-icon">Agent<wbr>Ingresses</a>
142
+ </li>
143
+ <li class=" tsd-kind-class tsd-parent-kind-module">
144
+ <a href="../classes/services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
145
+ </li>
146
+ <li class=" tsd-kind-class tsd-parent-kind-module">
147
+ <a href="../classes/services.Credentials.html" class="tsd-kind-icon">Credentials</a>
148
+ </li>
149
+ <li class=" tsd-kind-class tsd-parent-kind-module">
150
+ <a href="../classes/services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a>
151
+ </li>
152
+ <li class=" tsd-kind-class tsd-parent-kind-module">
153
+ <a href="../classes/services.EndpointCompressionModule.html" class="tsd-kind-icon">Endpoint<wbr>Compression<wbr>Module</a>
154
+ </li>
155
+ <li class=" tsd-kind-class tsd-parent-kind-module">
156
+ <a href="../classes/services.EndpointConfigurations.html" class="tsd-kind-icon">Endpoint<wbr>Configurations</a>
157
+ </li>
158
+ <li class=" tsd-kind-class tsd-parent-kind-module">
159
+ <a href="../classes/services.EndpointIPPolicyModule.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Module</a>
160
+ </li>
161
+ <li class=" tsd-kind-class tsd-parent-kind-module">
162
+ <a href="../classes/services.EndpointLoggingModule.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Module</a>
163
+ </li>
164
+ <li class=" tsd-kind-class tsd-parent-kind-module">
165
+ <a href="../classes/services.EndpointMutualTLSModule.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSModule</a>
166
+ </li>
167
+ <li class=" tsd-kind-class tsd-parent-kind-module">
168
+ <a href="../classes/services.EndpointOAuthModule.html" class="tsd-kind-icon">EndpointOAuth<wbr>Module</a>
169
+ </li>
170
+ <li class=" tsd-kind-class tsd-parent-kind-module">
171
+ <a href="../classes/services.EndpointOIDCModule.html" class="tsd-kind-icon">EndpointOIDCModule</a>
172
+ </li>
173
+ <li class=" tsd-kind-class tsd-parent-kind-module">
174
+ <a href="../classes/services.EndpointRequestHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers<wbr>Module</a>
175
+ </li>
176
+ <li class=" tsd-kind-class tsd-parent-kind-module">
177
+ <a href="../classes/services.EndpointResponseHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers<wbr>Module</a>
178
+ </li>
179
+ <li class=" tsd-kind-class tsd-parent-kind-module">
180
+ <a href="../classes/services.EndpointSAMLModule.html" class="tsd-kind-icon">EndpointSAMLModule</a>
181
+ </li>
182
+ <li class=" tsd-kind-class tsd-parent-kind-module">
183
+ <a href="../classes/services.EndpointTLSTerminationModule.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>Module</a>
184
+ </li>
185
+ <li class=" tsd-kind-class tsd-parent-kind-module">
186
+ <a href="../classes/services.EndpointWebhookValidationModule.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation<wbr>Module</a>
187
+ </li>
188
+ <li class=" tsd-kind-class tsd-parent-kind-module">
189
+ <a href="../classes/services.EventDestinations.html" class="tsd-kind-icon">Event<wbr>Destinations</a>
190
+ </li>
191
+ <li class=" tsd-kind-class tsd-parent-kind-module">
192
+ <a href="../classes/services.EventSources.html" class="tsd-kind-icon">Event<wbr>Sources</a>
193
+ </li>
194
+ <li class=" tsd-kind-class tsd-parent-kind-module">
195
+ <a href="../classes/services.EventStreams.html" class="tsd-kind-icon">Event<wbr>Streams</a>
196
+ </li>
197
+ <li class=" tsd-kind-class tsd-parent-kind-module">
198
+ <a href="../classes/services.EventSubscriptions.html" class="tsd-kind-icon">Event<wbr>Subscriptions</a>
199
+ </li>
200
+ <li class=" tsd-kind-class tsd-parent-kind-module">
201
+ <a href="../classes/services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a>
202
+ </li>
203
+ <li class=" tsd-kind-class tsd-parent-kind-module">
204
+ <a href="../classes/services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a>
205
+ </li>
206
+ <li class=" tsd-kind-class tsd-parent-kind-module">
207
+ <a href="../classes/services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
208
+ </li>
209
+ <li class=" tsd-kind-class tsd-parent-kind-module">
210
+ <a href="../classes/services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
211
+ </li>
212
+ <li class=" tsd-kind-class tsd-parent-kind-module">
213
+ <a href="../classes/services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a>
214
+ </li>
215
+ <li class=" tsd-kind-class tsd-parent-kind-module">
216
+ <a href="../classes/services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a>
217
+ </li>
218
+ <li class=" tsd-kind-class tsd-parent-kind-module">
219
+ <a href="../classes/services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a>
220
+ </li>
221
+ <li class=" tsd-kind-class tsd-parent-kind-module">
222
+ <a href="../classes/services.SSHHostCertificates.html" class="tsd-kind-icon">SSHHost<wbr>Certificates</a>
223
+ </li>
224
+ <li class=" tsd-kind-class tsd-parent-kind-module">
225
+ <a href="../classes/services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a>
226
+ </li>
227
+ <li class=" tsd-kind-class tsd-parent-kind-module">
228
+ <a href="../classes/services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a>
229
+ </li>
230
+ <li class=" tsd-kind-class tsd-parent-kind-module">
231
+ <a href="../classes/services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a>
232
+ </li>
233
+ <li class=" tsd-kind-class tsd-parent-kind-module">
234
+ <a href="../classes/services.Tunnels.html" class="tsd-kind-icon">Tunnels</a>
235
+ </li>
236
+ </ul>
237
+ </nav>
238
+ </div>
239
+ </div>
240
+ </div>
241
+ <footer class="with-border-bottom">
242
+ <div class="container">
243
+ <h2>Legend</h2>
244
+ <div class="tsd-legend-group">
245
+ <ul class="tsd-legend">
246
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
247
+ </ul>
248
+ <ul class="tsd-legend">
249
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
250
+ </ul>
251
+ </div>
252
+ </div>
253
+ </footer>
254
+ <div class="container tsd-generator">
255
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
256
+ </div>
257
+ <div class="overlay"></div>
258
+ <script src="../assets/js/main.js"></script>
259
+ </body>
260
+ </html>
package/docs/modules.html ADDED
@@ -0,0 +1,119 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>@ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="assets/css/main.css">
10
+ <script async src="assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <h1>@ngrok/ngrok-api</h1>
54
+ </div>
55
+ </div>
56
+ </header>
57
+ <div class="container container-main">
58
+ <div class="row">
59
+ <div class="col-8 col-content">
60
+ <section class="tsd-panel-group tsd-index-group">
61
+ <h2>Index</h2>
62
+ <section class="tsd-panel tsd-index-panel">
63
+ <div class="tsd-index-content">
64
+ <section class="tsd-index-section ">
65
+ <h3>Modules</h3>
66
+ <ul class="tsd-index-list">
67
+ <li class="tsd-kind-module"><a href="modules/client.html" class="tsd-kind-icon">client</a></li>
68
+ <li class="tsd-kind-module"><a href="modules/datatypes.html" class="tsd-kind-icon">datatypes</a></li>
69
+ <li class="tsd-kind-module"><a href="modules/services.html" class="tsd-kind-icon">services</a></li>
70
+ </ul>
71
+ </section>
72
+ </div>
73
+ </section>
74
+ </section>
75
+ </div>
76
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
77
+ <nav class="tsd-navigation primary">
78
+ <ul>
79
+ <li class="current ">
80
+ <a href="modules.html">Modules</a>
81
+ </li>
82
+ <li class=" tsd-kind-module">
83
+ <a href="modules/client.html">client</a>
84
+ </li>
85
+ <li class=" tsd-kind-module">
86
+ <a href="modules/datatypes.html">datatypes</a>
87
+ </li>
88
+ <li class=" tsd-kind-module">
89
+ <a href="modules/services.html">services</a>
90
+ </li>
91
+ </ul>
92
+ </nav>
93
+ <nav class="tsd-navigation secondary menu-sticky">
94
+ <ul class="before-current">
95
+ </ul>
96
+ </nav>
97
+ </div>
98
+ </div>
99
+ </div>
100
+ <footer class="with-border-bottom">
101
+ <div class="container">
102
+ <h2>Legend</h2>
103
+ <div class="tsd-legend-group">
104
+ <ul class="tsd-legend">
105
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
106
+ </ul>
107
+ <ul class="tsd-legend">
108
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
109
+ </ul>
110
+ </div>
111
+ </div>
112
+ </footer>
113
+ <div class="container tsd-generator">
114
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
115
+ </div>
116
+ <div class="overlay"></div>
117
+ <script src="assets/js/main.js"></script>
118
+ </body>
119
+ </html>
package/lib/client.d.ts ADDED
@@ -0,0 +1,145 @@
1
+ import * as services from './services';
2
+ export interface NgrokConfig {
3
+ apiToken: string;
4
+ baseUrl: string;
5
+ }
6
+ export declare class Ngrok {
7
+ private token;
8
+ private baseUrl;
9
+ private httpClient;
10
+ /**
11
+ * Abuse Reports allow you to submit take-down requests for URLs hosted by
12
+ ngrok that violate ngrok's terms of service.
13
+ */
14
+ abuseReports: services.AbuseReports;
15
+ agentIngresses: services.AgentIngresses;
16
+ /**
17
+ * API Keys are used to authenticate to the [ngrok
18
+ API](https://ngrok.com/docs/api#authentication). You may use the API itself
19
+ to provision and manage API Keys but you'll need to provision your first API
20
+ key from the [API Keys page](https://dashboard.ngrok.com/api/keys) on your
21
+ ngrok.com dashboard.
22
+ */
23
+ apiKeys: services.APIKeys;
24
+ /**
25
+ * Certificate Authorities are x509 certificates that are used to sign other
26
+ x509 certificates. Attach a Certificate Authority to the Mutual TLS module
27
+ to verify that the TLS certificate presented by a client has been signed by
28
+ this CA. Certificate Authorities are used only for mTLS validation only and
29
+ thus a private key is not included in the resource.
30
+ */
31
+ certificateAuthorities: services.CertificateAuthorities;
32
+ /**
33
+ * Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
34
+ agent to connect the ngrok service as your account. They are installed with
35
+ the `ngrok authtoken` command or by specifying it in the `ngrok.yml`
36
+ configuration file with the `authtoken` property.
37
+ */
38
+ credentials: services.Credentials;
39
+ /**
40
+ * Endpoint Configurations are a reusable group of modules that encapsulate how
41
+ traffic to a domain or address is handled. Endpoint configurations are only
42
+ applied to Domains and TCP Addresses they have been attached to.
43
+ */
44
+ endpointConfigurations: services.EndpointConfigurations;
45
+ eventStreams: services.EventStreams;
46
+ eventDestinations: services.EventDestinations;
47
+ eventSubscriptions: services.EventSubscriptions;
48
+ eventSources: services.EventSources;
49
+ /**
50
+ * IP Policies are reusable groups of CIDR ranges with an `allow` or `deny`
51
+ action. They can be attached to endpoints via the Endpoint Configuration IP
52
+ Policy module. They can also be used with IP Restrictions to control source
53
+ IP ranges that can start tunnel sessions and connect to the API and dashboard.
54
+ */
55
+ ipPolicies: services.IPPolicies;
56
+ /**
57
+ * IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
58
+ make up an IP Policy.
59
+ */
60
+ ipPolicyRules: services.IPPolicyRules;
61
+ /**
62
+ * An IP restriction is a restriction placed on the CIDRs that are allowed to
63
+ initate traffic to a specific aspect of your ngrok account. An IP
64
+ restriction has a type which defines the ingress it applies to. IP
65
+ restrictions can be used to enforce the source IPs that can make API
66
+ requests, log in to the dashboard, start ngrok agents, and connect to your
67
+ public-facing endpoints.
68
+ */
69
+ ipRestrictions: services.IPRestrictions;
70
+ /**
71
+ * Reserved Addresses are TCP addresses that can be used to listen for traffic.
72
+ TCP address hostnames and ports are assigned by ngrok, they cannot be
73
+ chosen.
74
+ */
75
+ reservedAddrs: services.ReservedAddrs;
76
+ /**
77
+ * Reserved Domains are hostnames that you can listen for traffic on. Domains
78
+ can be used to listen for http, https or tls traffic. You may use a domain
79
+ that you own by creating a CNAME record specified in the returned resource.
80
+ This CNAME record points traffic for that domain to ngrok's edge servers.
81
+ */
82
+ reservedDomains: services.ReservedDomains;
83
+ /**
84
+ * An SSH Certificate Authority is a pair of an SSH Certificate and its private
85
+ key that can be used to sign other SSH host and user certificates.
86
+ */
87
+ sshCertificateAuthorities: services.SSHCertificateAuthorities;
88
+ /**
89
+ * SSH Credentials are SSH public keys that can be used to start SSH tunnels
90
+ via the ngrok SSH tunnel gateway.
91
+ */
92
+ sshCredentials: services.SSHCredentials;
93
+ /**
94
+ * SSH Host Certificates along with the corresponding private key allows an SSH
95
+ server to assert its authenticity to connecting SSH clients who trust the
96
+ SSH Certificate Authority that was used to sign the certificate.
97
+ */
98
+ sshHostCertificates: services.SSHHostCertificates;
99
+ /**
100
+ * SSH User Certificates are presented by SSH clients when connecting to an SSH
101
+ server to authenticate their connection. The SSH server must trust the SSH
102
+ Certificate Authority used to sign the certificate.
103
+ */
104
+ sshUserCertificates: services.SSHUserCertificates;
105
+ /**
106
+ * TLS Certificates are pairs of x509 certificates and their matching private
107
+ key that can be used to terminate TLS traffic. TLS certificates are unused
108
+ until they are attached to a Domain. TLS Certificates may also be
109
+ provisioned by ngrok automatically for domains on which you have enabled
110
+ automated certificate provisioning.
111
+ */
112
+ tlsCertificates: services.TLSCertificates;
113
+ /**
114
+ * Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
115
+ sessions that are running and connected to the ngrok service. Each tunnel
116
+ session can include one or more Tunnels.
117
+ */
118
+ tunnelSessions: services.TunnelSessions;
119
+ /**
120
+ * Tunnels provide endpoints to access services exposed by a running ngrok
121
+ agent tunnel session or an SSH reverse tunnel session.
122
+ */
123
+ tunnels: services.Tunnels;
124
+ pointcfgModule: {
125
+ endpointLoggingModule: services.EndpointLoggingModule;
126
+ endpointCircuitBreakerModule: services.EndpointCircuitBreakerModule;
127
+ endpointCompressionModule: services.EndpointCompressionModule;
128
+ endpointTlsTerminationModule: services.EndpointTLSTerminationModule;
129
+ endpointIpPolicyModule: services.EndpointIPPolicyModule;
130
+ endpointMutualTlsModule: services.EndpointMutualTLSModule;
131
+ endpointRequestHeadersModule: services.EndpointRequestHeadersModule;
132
+ endpointResponseHeadersModule: services.EndpointResponseHeadersModule;
133
+ endpointOAuthModule: services.EndpointOAuthModule;
134
+ endpointWebhookValidationModule: services.EndpointWebhookValidationModule;
135
+ endpointSamlModule: services.EndpointSAMLModule;
136
+ endpointOidcModule: services.EndpointOIDCModule;
137
+ };
138
+ /**
139
+ * Creates an instance of the Ngrok HTTP API client
140
+ * @constructor
141
+ * @param {Object} config - config.apiToken and config.baseUrl
142
+ */
143
+ constructor({ baseUrl, apiToken }: NgrokConfig);
144
+ }
145
+ //# sourceMappingURL=client.d.ts.map
package/lib/client.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AAQvC,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,KAAK;IAChB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,UAAU,CAAW;IAC7B;;;OAGG;IACI,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;IACpC,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;;;;OAMG;IACI,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;IACjC;;;;;;OAMG;IACI,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAC;IAC/D;;;;;OAKG;IACI,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC;IACzC;;;;OAIG;IACI,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAC;IACxD,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;IACpC,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAC9C,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAC;IAChD,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;IAC3C;;;;;OAKG;IACI,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;IACvC;;;OAGG;IACI,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC;IAC7C;;;;;;;OAOG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;;OAIG;IACI,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC;IAC7C;;;;;OAKG;IACI,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC;IACjD;;;OAGG;IACI,yBAAyB,EAAE,QAAQ,CAAC,yBAAyB,CAAC;IACrE;;;OAGG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;;OAIG;IACI,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;IACzD;;;;OAIG;IACI,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;IACzD;;;;;;OAMG;IACI,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC;IACjD;;;;OAIG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;OAGG;IACI,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;IAC1B,cAAc,EAAE;QACrB,qBAAqB,EAAE,QAAQ,CAAC,qBAAqB,CAAA;QACrD,4BAA4B,EAAE,QAAQ,CAAC,4BAA4B,CAAA;QACnE,yBAAyB,EAAE,QAAQ,CAAC,yBAAyB,CAAA;QAC7D,4BAA4B,EAAE,QAAQ,CAAC,4BAA4B,CAAA;QACnE,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAA;QACvD,uBAAuB,EAAE,QAAQ,CAAC,uBAAuB,CAAA;QACzD,4BAA4B,EAAE,QAAQ,CAAC,4BAA4B,CAAA;QACnE,6BAA6B,EAAE,QAAQ,CAAC,6BAA6B,CAAA;QACrE,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAA;QACjD,+BAA+B,EAAE,QAAQ,CAAC,+BAA+B,CAAA;QACzE,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAA;QAC/C,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAA;KAChD,CAAC;IAEF;;;;OAIG;gBACgB,EAAC,OAAiC,EAAE,QAAQ,EAAC,EAAE,WAAW;CA8E9E"}
package/lib/client.js ADDED
@@ -0,0 +1,102 @@
1
+ 'use strict';
2
+ // Code generated by apic. DO NOT EDIT.
3
+ Object.defineProperty(exports, '__esModule', { value: true });
4
+ exports.Ngrok = void 0;
5
+ const wretch_1 = require('wretch');
6
+ const formData = require('form-data');
7
+ const url_1 = require('url');
8
+ const node_fetch_1 = require('node-fetch');
9
+ const services = require('./services');
10
+ (0, wretch_1.default)().polyfills({
11
+ fetch: node_fetch_1.default,
12
+ FormData: formData,
13
+ URLSearchParams: url_1.URLSearchParams,
14
+ });
15
+ class Ngrok {
16
+ /**
17
+ * Creates an instance of the Ngrok HTTP API client
18
+ * @constructor
19
+ * @param {Object} config - config.apiToken and config.baseUrl
20
+ */
21
+ constructor({ baseUrl = 'https://api.ngrok.com', apiToken }) {
22
+ this.baseUrl = baseUrl;
23
+ if (apiToken) {
24
+ this.token = apiToken;
25
+ } else {
26
+ throw new Error('Cannot create ngrok client without an API token');
27
+ }
28
+ this.httpClient = (0, wretch_1.default)()
29
+ .url(baseUrl)
30
+ .headers({
31
+ 'User-Agent': 'ngrok-ts-user-agent',
32
+ 'Ngrok-Version': '2',
33
+ })
34
+ .content('application/json')
35
+ .auth('Bearer ' + this.token);
36
+ this.abuseReports = new services.AbuseReports(this.httpClient);
37
+ this.agentIngresses = new services.AgentIngresses(this.httpClient);
38
+ this.apiKeys = new services.APIKeys(this.httpClient);
39
+ this.certificateAuthorities = new services.CertificateAuthorities(
40
+ this.httpClient
41
+ );
42
+ this.credentials = new services.Credentials(this.httpClient);
43
+ this.endpointConfigurations = new services.EndpointConfigurations(
44
+ this.httpClient
45
+ );
46
+ this.eventStreams = new services.EventStreams(this.httpClient);
47
+ this.eventDestinations = new services.EventDestinations(this.httpClient);
48
+ this.eventSubscriptions = new services.EventSubscriptions(this.httpClient);
49
+ this.eventSources = new services.EventSources(this.httpClient);
50
+ this.ipPolicies = new services.IPPolicies(this.httpClient);
51
+ this.ipPolicyRules = new services.IPPolicyRules(this.httpClient);
52
+ this.ipRestrictions = new services.IPRestrictions(this.httpClient);
53
+ this.reservedAddrs = new services.ReservedAddrs(this.httpClient);
54
+ this.reservedDomains = new services.ReservedDomains(this.httpClient);
55
+ this.sshCertificateAuthorities = new services.SSHCertificateAuthorities(
56
+ this.httpClient
57
+ );
58
+ this.sshCredentials = new services.SSHCredentials(this.httpClient);
59
+ this.sshHostCertificates = new services.SSHHostCertificates(
60
+ this.httpClient
61
+ );
62
+ this.sshUserCertificates = new services.SSHUserCertificates(
63
+ this.httpClient
64
+ );
65
+ this.tlsCertificates = new services.TLSCertificates(this.httpClient);
66
+ this.tunnelSessions = new services.TunnelSessions(this.httpClient);
67
+ this.tunnels = new services.Tunnels(this.httpClient);
68
+ this.pointcfgModule = {
69
+ endpointLoggingModule: new services.EndpointLoggingModule(
70
+ this.httpClient
71
+ ),
72
+ endpointCircuitBreakerModule: new services.EndpointCircuitBreakerModule(
73
+ this.httpClient
74
+ ),
75
+ endpointCompressionModule: new services.EndpointCompressionModule(
76
+ this.httpClient
77
+ ),
78
+ endpointTlsTerminationModule: new services.EndpointTLSTerminationModule(
79
+ this.httpClient
80
+ ),
81
+ endpointIpPolicyModule: new services.EndpointIPPolicyModule(
82
+ this.httpClient
83
+ ),
84
+ endpointMutualTlsModule: new services.EndpointMutualTLSModule(
85
+ this.httpClient
86
+ ),
87
+ endpointRequestHeadersModule: new services.EndpointRequestHeadersModule(
88
+ this.httpClient
89
+ ),
90
+ endpointResponseHeadersModule: new services.EndpointResponseHeadersModule(
91
+ this.httpClient
92
+ ),
93
+ endpointOAuthModule: new services.EndpointOAuthModule(this.httpClient),
94
+ endpointWebhookValidationModule:
95
+ new services.EndpointWebhookValidationModule(this.httpClient),
96
+ endpointSamlModule: new services.EndpointSAMLModule(this.httpClient),
97
+ endpointOidcModule: new services.EndpointOIDCModule(this.httpClient),
98
+ };
99
+ }
100
+ }
101
+ exports.Ngrok = Ngrok;
102
+ //# sourceMappingURL=client.js.map
package/lib/client.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,mCAA0C;AAC1C,sCAAsC;AACtC,6BAAsC;AACtC,2CAAmC;AACnC,uCAAuC;AAEvC,IAAA,gBAAM,GAAE,CAAC,SAAS,CAAC;IACf,KAAK,EAAE,oBAAS;IAChB,QAAQ,EAAE,QAAQ;IAClB,eAAe,EAAf,qBAAe;CAClB,CAAC,CAAC;AAOH,MAAa,KAAK;IAqIhB;;;;OAIG;IACH,YAAmB,EAAC,OAAO,GAAG,uBAAuB,EAAE,QAAQ,EAAc;QAC3E,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,QAAQ,EAAE;YACZ,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;SACvB;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACpE;QAED,IAAI,CAAC,UAAU,GAAG,IAAA,gBAAM,GAAE;aACvB,GAAG,CAAC,OAAO,CAAC;aACZ,OAAO,CAAC;YACP,YAAY,EAAE,qBAAqB;YACnC,eAAe,EAAE,GAAG;SACrB,CAAC;aACD,OAAO,CAAC,kBAAkB,CAAC;aAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAG9B,IAAI,CAAC,YAAY,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnE,IAAI,CAAC,OAAO,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErD,IAAI,CAAC,sBAAsB,GAAG,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnF,IAAI,CAAC,WAAW,GAAG,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7D,IAAI,CAAC,sBAAsB,GAAG,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnF,IAAI,CAAC,YAAY,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,iBAAiB,GAAG,IAAI,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEzE,IAAI,CAAC,kBAAkB,GAAG,IAAI,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE3E,IAAI,CAAC,YAAY,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/D,IAAI,CAAC,UAAU,GAAG,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE3D,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEjE,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnE,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEjE,IAAI,CAAC,eAAe,GAAG,IAAI,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErE,IAAI,CAAC,yBAAyB,GAAG,IAAI,QAAQ,CAAC,yBAAyB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEzF,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnE,IAAI,CAAC,mBAAmB,GAAG,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7E,IAAI,CAAC,mBAAmB,GAAG,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7E,IAAI,CAAC,eAAe,GAAG,IAAI,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErE,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEnE,IAAI,CAAC,OAAO,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAErD,IAAI,CAAC,cAAc,GAAG;YAC3B,qBAAqB,EAAE,IAAI,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1E,4BAA4B,EAAE,IAAI,QAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,CAAC;YACxF,yBAAyB,EAAE,IAAI,QAAQ,CAAC,yBAAyB,CAAC,IAAI,CAAC,UAAU,CAAC;YAClF,4BAA4B,EAAE,IAAI,QAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,CAAC;YACxF,sBAAsB,EAAE,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC5E,uBAAuB,EAAE,IAAI,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC9E,4BAA4B,EAAE,IAAI,QAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,CAAC;YACxF,6BAA6B,EAAE,IAAI,QAAQ,CAAC,6BAA6B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1F,mBAAmB,EAAE,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACtE,+BAA+B,EAAE,IAAI,QAAQ,CAAC,+BAA+B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC9F,kBAAkB,EAAE,IAAI,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC;YACpE,kBAAkB,EAAE,IAAI,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC;SAC9D,CAAC;IACN,CAAC;CACF;AAxND,sBAwNC"}