@ngrok/ngrok-api 0.2.0 → 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 (190) hide show
  1. package/docs/CNAME +1 -0
  2. package/docs/assets/js/search.js +1 -1
  3. package/docs/classes/client.Ngrok.html +37 -43
  4. package/docs/classes/services.APIKeys.html +9 -9
  5. package/docs/classes/services.AbuseReports.html +6 -6
  6. package/docs/classes/{services.IPWhitelist.html → services.AgentIngresses.html} +61 -69
  7. package/docs/classes/services.CertificateAuthorities.html +9 -9
  8. package/docs/classes/services.Credentials.html +9 -9
  9. package/docs/classes/services.EndpointCircuitBreakerModule.html +7 -7
  10. package/docs/classes/services.EndpointCompressionModule.html +7 -7
  11. package/docs/classes/services.EndpointConfigurations.html +9 -9
  12. package/docs/classes/services.EndpointIPPolicyModule.html +7 -7
  13. package/docs/classes/services.EndpointLoggingModule.html +7 -7
  14. package/docs/classes/services.EndpointMutualTLSModule.html +7 -7
  15. package/docs/classes/services.EndpointOAuthModule.html +7 -7
  16. package/docs/classes/services.EndpointOIDCModule.html +7 -7
  17. package/docs/classes/services.EndpointRequestHeadersModule.html +7 -7
  18. package/docs/classes/services.EndpointResponseHeadersModule.html +7 -7
  19. package/docs/classes/services.EndpointSAMLModule.html +7 -7
  20. package/docs/classes/services.EndpointTLSTerminationModule.html +7 -7
  21. package/docs/classes/services.EndpointWebhookValidationModule.html +7 -7
  22. package/docs/classes/services.EventDestinations.html +9 -9
  23. package/docs/classes/services.EventSources.html +9 -9
  24. package/docs/classes/services.EventStreams.html +9 -9
  25. package/docs/classes/services.EventSubscriptions.html +9 -9
  26. package/docs/classes/services.IPPolicies.html +9 -9
  27. package/docs/classes/services.IPPolicyRules.html +9 -9
  28. package/docs/classes/services.IPRestrictions.html +9 -9
  29. package/docs/classes/services.ReservedAddrs.html +10 -10
  30. package/docs/classes/services.ReservedDomains.html +13 -13
  31. package/docs/classes/services.SSHCertificateAuthorities.html +9 -9
  32. package/docs/classes/services.SSHCredentials.html +9 -9
  33. package/docs/classes/services.SSHHostCertificates.html +9 -9
  34. package/docs/classes/services.SSHUserCertificates.html +9 -9
  35. package/docs/classes/services.TLSCertificates.html +9 -9
  36. package/docs/classes/services.TunnelSessions.html +9 -9
  37. package/docs/classes/services.Tunnels.html +5 -5
  38. package/docs/interfaces/client.NgrokConfig.html +2 -2
  39. package/docs/interfaces/datatypes.APIKey.html +6 -6
  40. package/docs/interfaces/datatypes.APIKeyCreate.html +2 -2
  41. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  42. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  43. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  44. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  45. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  46. package/docs/interfaces/datatypes.AbuseReport.html +7 -7
  47. package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
  48. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  49. package/docs/interfaces/{datatypes.IPWhitelistEntry.html → datatypes.AgentIngress.html} +73 -35
  50. package/docs/interfaces/{datatypes.IPWhitelistEntryCreate.html → datatypes.AgentIngressCreate.html} +20 -20
  51. package/docs/interfaces/{datatypes.IPWhitelistEntryList.html → datatypes.AgentIngressList.html} +26 -26
  52. package/docs/interfaces/{datatypes.IPWhitelistEntryUpdate.html → datatypes.AgentIngressUpdate.html} +16 -16
  53. package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
  54. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
  55. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  56. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  57. package/docs/interfaces/datatypes.Credential.html +7 -7
  58. package/docs/interfaces/datatypes.CredentialCreate.html +3 -3
  59. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  60. package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
  61. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  62. package/docs/interfaces/datatypes.EndpointCircuitBreakerReplace.html +2 -2
  63. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  64. package/docs/interfaces/datatypes.EndpointCompressionReplace.html +2 -2
  65. package/docs/interfaces/datatypes.EndpointConfiguration.html +18 -18
  66. package/docs/interfaces/datatypes.EndpointConfigurationCreate.html +15 -15
  67. package/docs/interfaces/datatypes.EndpointConfigurationList.html +3 -3
  68. package/docs/interfaces/datatypes.EndpointConfigurationUpdate.html +15 -15
  69. package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
  70. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  71. package/docs/interfaces/datatypes.EndpointIPPolicyReplace.html +2 -2
  72. package/docs/interfaces/datatypes.EndpointLogging.html +2 -2
  73. package/docs/interfaces/datatypes.EndpointLoggingMutate.html +2 -2
  74. package/docs/interfaces/datatypes.EndpointLoggingReplace.html +2 -2
  75. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  76. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  77. package/docs/interfaces/datatypes.EndpointMutualTLSReplace.html +2 -2
  78. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  79. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  80. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
  81. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  82. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  83. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +4 -4
  84. package/docs/interfaces/datatypes.EndpointOAuthReplace.html +2 -2
  85. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  86. package/docs/interfaces/datatypes.EndpointOIDCReplace.html +2 -2
  87. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  88. package/docs/interfaces/datatypes.EndpointRequestHeadersReplace.html +2 -2
  89. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  90. package/docs/interfaces/datatypes.EndpointResponseHeadersReplace.html +2 -2
  91. package/docs/interfaces/datatypes.EndpointSAML.html +33 -14
  92. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +28 -9
  93. package/docs/interfaces/datatypes.EndpointSAMLReplace.html +2 -2
  94. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  95. package/docs/interfaces/datatypes.EndpointTLSTerminationReplace.html +2 -2
  96. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
  97. package/docs/interfaces/datatypes.EndpointWebhookValidationReplace.html +2 -2
  98. package/docs/interfaces/datatypes.Error.html +4 -4
  99. package/docs/interfaces/datatypes.EventDestination.html +7 -7
  100. package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
  101. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  102. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  103. package/docs/interfaces/datatypes.EventSource.html +2 -2
  104. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  105. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  106. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  107. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  108. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  109. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  110. package/docs/interfaces/datatypes.EventStream.html +9 -9
  111. package/docs/interfaces/datatypes.EventStreamCreate.html +6 -6
  112. package/docs/interfaces/datatypes.EventStreamList.html +3 -3
  113. package/docs/interfaces/datatypes.EventStreamUpdate.html +6 -6
  114. package/docs/interfaces/datatypes.EventSubscription.html +7 -7
  115. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +4 -4
  116. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  117. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
  118. package/docs/interfaces/datatypes.EventTarget.html +3 -3
  119. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  120. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  121. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  122. package/docs/interfaces/datatypes.IPPolicy.html +6 -6
  123. package/docs/interfaces/datatypes.IPPolicyCreate.html +3 -3
  124. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  125. package/docs/interfaces/datatypes.IPPolicyRule.html +7 -7
  126. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +4 -4
  127. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  128. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  129. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  130. package/docs/interfaces/datatypes.IPRestriction.html +8 -8
  131. package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
  132. package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
  133. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  134. package/docs/interfaces/datatypes.Item.html +1 -1
  135. package/docs/interfaces/datatypes.Paging.html +2 -2
  136. package/docs/interfaces/datatypes.Ref.html +2 -2
  137. package/docs/interfaces/datatypes.ReservedAddr.html +8 -8
  138. package/docs/interfaces/datatypes.ReservedAddrCreate.html +5 -5
  139. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  140. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +4 -4
  141. package/docs/interfaces/datatypes.ReservedDomain.html +32 -13
  142. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -23
  143. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  144. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
  145. package/docs/interfaces/datatypes.ReservedDomainCreate.html +8 -8
  146. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  147. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +7 -7
  148. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
  149. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
  150. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  151. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  152. package/docs/interfaces/datatypes.SSHCredential.html +7 -7
  153. package/docs/interfaces/datatypes.SSHCredentialCreate.html +4 -4
  154. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  155. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
  156. package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
  157. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
  158. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  159. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  160. package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
  161. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
  162. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  163. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  164. package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
  165. package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
  166. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  167. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  168. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  169. package/docs/interfaces/datatypes.Tunnel.html +7 -7
  170. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  171. package/docs/interfaces/datatypes.TunnelSession.html +10 -10
  172. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  173. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  174. package/docs/modules/datatypes.html +16 -20
  175. package/docs/modules/services.html +4 -4
  176. package/lib/client.d.ts +1 -5
  177. package/lib/client.d.ts.map +1 -1
  178. package/lib/client.js +3 -4
  179. package/lib/client.js.map +1 -1
  180. package/lib/datatypes.d.ts +49 -47
  181. package/lib/datatypes.d.ts.map +1 -1
  182. package/lib/services.d.ts +27 -31
  183. package/lib/services.d.ts.map +1 -1
  184. package/lib/services.js +155 -159
  185. package/lib/services.js.map +1 -1
  186. package/package.json +1 -1
  187. package/src/client.ts +3 -7
  188. package/src/datatypes.ts +53 -52
  189. package/src/services.ts +98 -102
  190. package/docs/interfaces/datatypes.ReservedDomainCertNSTarget.html +0 -186
package/docs/classes/client.Ngrok.html CHANGED
@@ -90,6 +90,7 @@
90
90
  <h3>Properties</h3>
91
91
  <ul class="tsd-index-list">
92
92
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#abuseReports" class="tsd-kind-icon">abuse<wbr>Reports</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#agentIngresses" class="tsd-kind-icon">agent<wbr>Ingresses</a></li>
93
94
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#apiKeys" class="tsd-kind-icon">api<wbr>Keys</a></li>
94
95
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#certificateAuthorities" class="tsd-kind-icon">certificate<wbr>Authorities</a></li>
95
96
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#credentials" class="tsd-kind-icon">credentials</a></li>
@@ -101,7 +102,6 @@
101
102
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#ipPolicies" class="tsd-kind-icon">ip<wbr>Policies</a></li>
102
103
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#ipPolicyRules" class="tsd-kind-icon">ip<wbr>Policy<wbr>Rules</a></li>
103
104
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#ipRestrictions" class="tsd-kind-icon">ip<wbr>Restrictions</a></li>
104
- <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#ipWhitelist" class="tsd-kind-icon">ip<wbr>Whitelist</a></li>
105
105
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#pointcfgModule" class="tsd-kind-icon">pointcfg<wbr>Module</a></li>
106
106
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#reservedAddrs" class="tsd-kind-icon">reserved<wbr>Addrs</a></li>
107
107
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#reservedDomains" class="tsd-kind-icon">reserved<wbr>Domains</a></li>
@@ -129,7 +129,7 @@
129
129
  <li class="tsd-description">
130
130
  <aside class="tsd-sources">
131
131
  <ul>
132
- <li>Defined in client.ts:162</li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L158">client.ts:158</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <div class="tsd-comment tsd-typography">
@@ -156,7 +156,7 @@
156
156
  <div class="tsd-signature tsd-kind-icon">abuse<wbr>Reports<span class="tsd-signature-symbol">:</span> <a href="services.AbuseReports.html" class="tsd-signature-type" data-tsd-kind="Class">AbuseReports</a></div>
157
157
  <aside class="tsd-sources">
158
158
  <ul>
159
- <li>Defined in client.ts:28</li>
159
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L28">client.ts:28</a></li>
160
160
  </ul>
161
161
  </aside>
162
162
  <div class="tsd-comment tsd-typography">
@@ -166,13 +166,23 @@
166
166
  </div>
167
167
  </div>
168
168
  </section>
169
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
170
+ <a name="agentIngresses" class="tsd-anchor"></a>
171
+ <h3>agent<wbr>Ingresses</h3>
172
+ <div class="tsd-signature tsd-kind-icon">agent<wbr>Ingresses<span class="tsd-signature-symbol">:</span> <a href="services.AgentIngresses.html" class="tsd-signature-type" data-tsd-kind="Class">AgentIngresses</a></div>
173
+ <aside class="tsd-sources">
174
+ <ul>
175
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L29">client.ts:29</a></li>
176
+ </ul>
177
+ </aside>
178
+ </section>
169
179
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
170
180
  <a name="apiKeys" class="tsd-anchor"></a>
171
181
  <h3>api<wbr>Keys</h3>
172
182
  <div class="tsd-signature tsd-kind-icon">api<wbr>Keys<span class="tsd-signature-symbol">:</span> <a href="services.APIKeys.html" class="tsd-signature-type" data-tsd-kind="Class">APIKeys</a></div>
173
183
  <aside class="tsd-sources">
174
184
  <ul>
175
- <li>Defined in client.ts:36</li>
185
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L37">client.ts:37</a></li>
176
186
  </ul>
177
187
  </aside>
178
188
  <div class="tsd-comment tsd-typography">
@@ -191,7 +201,7 @@
191
201
  <div class="tsd-signature tsd-kind-icon">certificate<wbr>Authorities<span class="tsd-signature-symbol">:</span> <a href="services.CertificateAuthorities.html" class="tsd-signature-type" data-tsd-kind="Class">CertificateAuthorities</a></div>
192
202
  <aside class="tsd-sources">
193
203
  <ul>
194
- <li>Defined in client.ts:44</li>
204
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L45">client.ts:45</a></li>
195
205
  </ul>
196
206
  </aside>
197
207
  <div class="tsd-comment tsd-typography">
@@ -210,7 +220,7 @@
210
220
  <div class="tsd-signature tsd-kind-icon">credentials<span class="tsd-signature-symbol">:</span> <a href="services.Credentials.html" class="tsd-signature-type" data-tsd-kind="Class">Credentials</a></div>
211
221
  <aside class="tsd-sources">
212
222
  <ul>
213
- <li>Defined in client.ts:51</li>
223
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L52">client.ts:52</a></li>
214
224
  </ul>
215
225
  </aside>
216
226
  <div class="tsd-comment tsd-typography">
@@ -228,7 +238,7 @@
228
238
  <div class="tsd-signature tsd-kind-icon">endpoint<wbr>Configurations<span class="tsd-signature-symbol">:</span> <a href="services.EndpointConfigurations.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointConfigurations</a></div>
229
239
  <aside class="tsd-sources">
230
240
  <ul>
231
- <li>Defined in client.ts:57</li>
241
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L58">client.ts:58</a></li>
232
242
  </ul>
233
243
  </aside>
234
244
  <div class="tsd-comment tsd-typography">
@@ -245,7 +255,7 @@
245
255
  <div class="tsd-signature tsd-kind-icon">event<wbr>Destinations<span class="tsd-signature-symbol">:</span> <a href="services.EventDestinations.html" class="tsd-signature-type" data-tsd-kind="Class">EventDestinations</a></div>
246
256
  <aside class="tsd-sources">
247
257
  <ul>
248
- <li>Defined in client.ts:59</li>
258
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L60">client.ts:60</a></li>
249
259
  </ul>
250
260
  </aside>
251
261
  </section>
@@ -255,7 +265,7 @@
255
265
  <div class="tsd-signature tsd-kind-icon">event<wbr>Sources<span class="tsd-signature-symbol">:</span> <a href="services.EventSources.html" class="tsd-signature-type" data-tsd-kind="Class">EventSources</a></div>
256
266
  <aside class="tsd-sources">
257
267
  <ul>
258
- <li>Defined in client.ts:61</li>
268
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L62">client.ts:62</a></li>
259
269
  </ul>
260
270
  </aside>
261
271
  </section>
@@ -265,7 +275,7 @@
265
275
  <div class="tsd-signature tsd-kind-icon">event<wbr>Streams<span class="tsd-signature-symbol">:</span> <a href="services.EventStreams.html" class="tsd-signature-type" data-tsd-kind="Class">EventStreams</a></div>
266
276
  <aside class="tsd-sources">
267
277
  <ul>
268
- <li>Defined in client.ts:58</li>
278
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L59">client.ts:59</a></li>
269
279
  </ul>
270
280
  </aside>
271
281
  </section>
@@ -275,7 +285,7 @@
275
285
  <div class="tsd-signature tsd-kind-icon">event<wbr>Subscriptions<span class="tsd-signature-symbol">:</span> <a href="services.EventSubscriptions.html" class="tsd-signature-type" data-tsd-kind="Class">EventSubscriptions</a></div>
276
286
  <aside class="tsd-sources">
277
287
  <ul>
278
- <li>Defined in client.ts:60</li>
288
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L61">client.ts:61</a></li>
279
289
  </ul>
280
290
  </aside>
281
291
  </section>
@@ -285,7 +295,7 @@
285
295
  <div class="tsd-signature tsd-kind-icon">ip<wbr>Policies<span class="tsd-signature-symbol">:</span> <a href="services.IPPolicies.html" class="tsd-signature-type" data-tsd-kind="Class">IPPolicies</a></div>
286
296
  <aside class="tsd-sources">
287
297
  <ul>
288
- <li>Defined in client.ts:68</li>
298
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L69">client.ts:69</a></li>
289
299
  </ul>
290
300
  </aside>
291
301
  <div class="tsd-comment tsd-typography">
@@ -303,7 +313,7 @@
303
313
  <div class="tsd-signature tsd-kind-icon">ip<wbr>Policy<wbr>Rules<span class="tsd-signature-symbol">:</span> <a href="services.IPPolicyRules.html" class="tsd-signature-type" data-tsd-kind="Class">IPPolicyRules</a></div>
304
314
  <aside class="tsd-sources">
305
315
  <ul>
306
- <li>Defined in client.ts:73</li>
316
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L74">client.ts:74</a></li>
307
317
  </ul>
308
318
  </aside>
309
319
  <div class="tsd-comment tsd-typography">
@@ -319,7 +329,7 @@
319
329
  <div class="tsd-signature tsd-kind-icon">ip<wbr>Restrictions<span class="tsd-signature-symbol">:</span> <a href="services.IPRestrictions.html" class="tsd-signature-type" data-tsd-kind="Class">IPRestrictions</a></div>
320
330
  <aside class="tsd-sources">
321
331
  <ul>
322
- <li>Defined in client.ts:82</li>
332
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L83">client.ts:83</a></li>
323
333
  </ul>
324
334
  </aside>
325
335
  <div class="tsd-comment tsd-typography">
@@ -333,29 +343,13 @@
333
343
  </div>
334
344
  </div>
335
345
  </section>
336
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
337
- <a name="ipWhitelist" class="tsd-anchor"></a>
338
- <h3>ip<wbr>Whitelist</h3>
339
- <div class="tsd-signature tsd-kind-icon">ip<wbr>Whitelist<span class="tsd-signature-symbol">:</span> <a href="services.IPWhitelist.html" class="tsd-signature-type" data-tsd-kind="Class">IPWhitelist</a></div>
340
- <aside class="tsd-sources">
341
- <ul>
342
- <li>Defined in client.ts:87</li>
343
- </ul>
344
- </aside>
345
- <div class="tsd-comment tsd-typography">
346
- <div class="lead">
347
- <p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction
348
- with an <code>endpoints</code> type instead.</p>
349
- </div>
350
- </div>
351
- </section>
352
346
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
353
347
  <a name="pointcfgModule" class="tsd-anchor"></a>
354
348
  <h3>pointcfg<wbr>Module</h3>
355
349
  <div class="tsd-signature tsd-kind-icon">pointcfg<wbr>Module<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>endpointCircuitBreakerModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointCircuitBreakerModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointCircuitBreakerModule</a><span class="tsd-signature-symbol">; </span>endpointCompressionModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointCompressionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointCompressionModule</a><span class="tsd-signature-symbol">; </span>endpointIpPolicyModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointIPPolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointIPPolicyModule</a><span class="tsd-signature-symbol">; </span>endpointLoggingModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointLoggingModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointLoggingModule</a><span class="tsd-signature-symbol">; </span>endpointMutualTlsModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointMutualTLSModule</a><span class="tsd-signature-symbol">; </span>endpointOAuthModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointOAuthModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointOAuthModule</a><span class="tsd-signature-symbol">; </span>endpointOidcModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointOIDCModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointOIDCModule</a><span class="tsd-signature-symbol">; </span>endpointRequestHeadersModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointRequestHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointRequestHeadersModule</a><span class="tsd-signature-symbol">; </span>endpointResponseHeadersModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointResponseHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointResponseHeadersModule</a><span class="tsd-signature-symbol">; </span>endpointSamlModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointSAMLModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointSAMLModule</a><span class="tsd-signature-symbol">; </span>endpointTlsTerminationModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointTLSTerminationModule</a><span class="tsd-signature-symbol">; </span>endpointWebhookValidationModule<span class="tsd-signature-symbol">: </span><a href="services.EndpointWebhookValidationModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointWebhookValidationModule</a><span class="tsd-signature-symbol"> }</span></div>
356
350
  <aside class="tsd-sources">
357
351
  <ul>
358
- <li>Defined in client.ts:142</li>
352
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L138">client.ts:138</a></li>
359
353
  </ul>
360
354
  </aside>
361
355
  <div class="tsd-type-declaration">
@@ -406,7 +400,7 @@
406
400
  <div class="tsd-signature tsd-kind-icon">reserved<wbr>Addrs<span class="tsd-signature-symbol">:</span> <a href="services.ReservedAddrs.html" class="tsd-signature-type" data-tsd-kind="Class">ReservedAddrs</a></div>
407
401
  <aside class="tsd-sources">
408
402
  <ul>
409
- <li>Defined in client.ts:93</li>
403
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L89">client.ts:89</a></li>
410
404
  </ul>
411
405
  </aside>
412
406
  <div class="tsd-comment tsd-typography">
@@ -423,7 +417,7 @@
423
417
  <div class="tsd-signature tsd-kind-icon">reserved<wbr>Domains<span class="tsd-signature-symbol">:</span> <a href="services.ReservedDomains.html" class="tsd-signature-type" data-tsd-kind="Class">ReservedDomains</a></div>
424
418
  <aside class="tsd-sources">
425
419
  <ul>
426
- <li>Defined in client.ts:100</li>
420
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L96">client.ts:96</a></li>
427
421
  </ul>
428
422
  </aside>
429
423
  <div class="tsd-comment tsd-typography">
@@ -441,7 +435,7 @@
441
435
  <div class="tsd-signature tsd-kind-icon">ssh<wbr>Certificate<wbr>Authorities<span class="tsd-signature-symbol">:</span> <a href="services.SSHCertificateAuthorities.html" class="tsd-signature-type" data-tsd-kind="Class">SSHCertificateAuthorities</a></div>
442
436
  <aside class="tsd-sources">
443
437
  <ul>
444
- <li>Defined in client.ts:105</li>
438
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L101">client.ts:101</a></li>
445
439
  </ul>
446
440
  </aside>
447
441
  <div class="tsd-comment tsd-typography">
@@ -457,7 +451,7 @@
457
451
  <div class="tsd-signature tsd-kind-icon">ssh<wbr>Credentials<span class="tsd-signature-symbol">:</span> <a href="services.SSHCredentials.html" class="tsd-signature-type" data-tsd-kind="Class">SSHCredentials</a></div>
458
452
  <aside class="tsd-sources">
459
453
  <ul>
460
- <li>Defined in client.ts:110</li>
454
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L106">client.ts:106</a></li>
461
455
  </ul>
462
456
  </aside>
463
457
  <div class="tsd-comment tsd-typography">
@@ -473,7 +467,7 @@
473
467
  <div class="tsd-signature tsd-kind-icon">ssh<wbr>Host<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="services.SSHHostCertificates.html" class="tsd-signature-type" data-tsd-kind="Class">SSHHostCertificates</a></div>
474
468
  <aside class="tsd-sources">
475
469
  <ul>
476
- <li>Defined in client.ts:116</li>
470
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L112">client.ts:112</a></li>
477
471
  </ul>
478
472
  </aside>
479
473
  <div class="tsd-comment tsd-typography">
@@ -490,7 +484,7 @@
490
484
  <div class="tsd-signature tsd-kind-icon">ssh<wbr>User<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="services.SSHUserCertificates.html" class="tsd-signature-type" data-tsd-kind="Class">SSHUserCertificates</a></div>
491
485
  <aside class="tsd-sources">
492
486
  <ul>
493
- <li>Defined in client.ts:122</li>
487
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L118">client.ts:118</a></li>
494
488
  </ul>
495
489
  </aside>
496
490
  <div class="tsd-comment tsd-typography">
@@ -507,7 +501,7 @@
507
501
  <div class="tsd-signature tsd-kind-icon">tls<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="services.TLSCertificates.html" class="tsd-signature-type" data-tsd-kind="Class">TLSCertificates</a></div>
508
502
  <aside class="tsd-sources">
509
503
  <ul>
510
- <li>Defined in client.ts:130</li>
504
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L126">client.ts:126</a></li>
511
505
  </ul>
512
506
  </aside>
513
507
  <div class="tsd-comment tsd-typography">
@@ -526,7 +520,7 @@
526
520
  <div class="tsd-signature tsd-kind-icon">tunnel<wbr>Sessions<span class="tsd-signature-symbol">:</span> <a href="services.TunnelSessions.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelSessions</a></div>
527
521
  <aside class="tsd-sources">
528
522
  <ul>
529
- <li>Defined in client.ts:136</li>
523
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L132">client.ts:132</a></li>
530
524
  </ul>
531
525
  </aside>
532
526
  <div class="tsd-comment tsd-typography">
@@ -543,7 +537,7 @@
543
537
  <div class="tsd-signature tsd-kind-icon">tunnels<span class="tsd-signature-symbol">:</span> <a href="services.Tunnels.html" class="tsd-signature-type" data-tsd-kind="Class">Tunnels</a></div>
544
538
  <aside class="tsd-sources">
545
539
  <ul>
546
- <li>Defined in client.ts:141</li>
540
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/client.ts#L137">client.ts:137</a></li>
547
541
  </ul>
548
542
  </aside>
549
543
  <div class="tsd-comment tsd-typography">
@@ -585,6 +579,9 @@
585
579
  <li class=" tsd-kind-property tsd-parent-kind-class">
586
580
  <a href="client.Ngrok.html#abuseReports" class="tsd-kind-icon">abuse<wbr>Reports</a>
587
581
  </li>
582
+ <li class=" tsd-kind-property tsd-parent-kind-class">
583
+ <a href="client.Ngrok.html#agentIngresses" class="tsd-kind-icon">agent<wbr>Ingresses</a>
584
+ </li>
588
585
  <li class=" tsd-kind-property tsd-parent-kind-class">
589
586
  <a href="client.Ngrok.html#apiKeys" class="tsd-kind-icon">api<wbr>Keys</a>
590
587
  </li>
@@ -618,9 +615,6 @@
618
615
  <li class=" tsd-kind-property tsd-parent-kind-class">
619
616
  <a href="client.Ngrok.html#ipRestrictions" class="tsd-kind-icon">ip<wbr>Restrictions</a>
620
617
  </li>
621
- <li class=" tsd-kind-property tsd-parent-kind-class">
622
- <a href="client.Ngrok.html#ipWhitelist" class="tsd-kind-icon">ip<wbr>Whitelist</a>
623
- </li>
624
618
  <li class=" tsd-kind-property tsd-parent-kind-class">
625
619
  <a href="client.Ngrok.html#pointcfgModule" class="tsd-kind-icon">pointcfg<wbr>Module</a>
626
620
  </li>
package/docs/classes/services.APIKeys.html CHANGED
@@ -122,7 +122,7 @@
122
122
  <li class="tsd-description">
123
123
  <aside class="tsd-sources">
124
124
  <ul>
125
- <li>Defined in services.ts:53</li>
125
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L151">services.ts:151</a></li>
126
126
  </ul>
127
127
  </aside>
128
128
  <div class="tsd-comment tsd-typography">
@@ -153,7 +153,7 @@
153
153
  <li class="tsd-description">
154
154
  <aside class="tsd-sources">
155
155
  <ul>
156
- <li>Defined in services.ts:59</li>
156
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L157">services.ts:157</a></li>
157
157
  </ul>
158
158
  </aside>
159
159
  <div class="tsd-comment tsd-typography">
@@ -181,7 +181,7 @@
181
181
  <li class="tsd-description">
182
182
  <aside class="tsd-sources">
183
183
  <ul>
184
- <li>Defined in services.ts:70</li>
184
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L168">services.ts:168</a></li>
185
185
  </ul>
186
186
  </aside>
187
187
  <div class="tsd-comment tsd-typography">
@@ -209,7 +209,7 @@
209
209
  <li class="tsd-description">
210
210
  <aside class="tsd-sources">
211
211
  <ul>
212
- <li>Defined in services.ts:81</li>
212
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L179">services.ts:179</a></li>
213
213
  </ul>
214
214
  </aside>
215
215
  <div class="tsd-comment tsd-typography">
@@ -237,7 +237,7 @@
237
237
  <li class="tsd-description">
238
238
  <aside class="tsd-sources">
239
239
  <ul>
240
- <li>Defined in services.ts:92</li>
240
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L190">services.ts:190</a></li>
241
241
  </ul>
242
242
  </aside>
243
243
  <div class="tsd-comment tsd-typography">
@@ -259,7 +259,7 @@
259
259
  <li class="tsd-description">
260
260
  <aside class="tsd-sources">
261
261
  <ul>
262
- <li>Defined in services.ts:132</li>
262
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L230">services.ts:230</a></li>
263
263
  </ul>
264
264
  </aside>
265
265
  <div class="tsd-comment tsd-typography">
@@ -328,6 +328,9 @@
328
328
  <li class=" tsd-kind-class tsd-parent-kind-module">
329
329
  <a href="services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
330
330
  </li>
331
+ <li class=" tsd-kind-class tsd-parent-kind-module">
332
+ <a href="services.AgentIngresses.html" class="tsd-kind-icon">Agent<wbr>Ingresses</a>
333
+ </li>
331
334
  <li class=" tsd-kind-class tsd-parent-kind-module">
332
335
  <a href="services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
333
336
  </li>
@@ -394,9 +397,6 @@
394
397
  <li class=" tsd-kind-class tsd-parent-kind-module">
395
398
  <a href="services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
396
399
  </li>
397
- <li class=" tsd-kind-class tsd-parent-kind-module">
398
- <a href="services.IPWhitelist.html" class="tsd-kind-icon">IPWhitelist</a>
399
- </li>
400
400
  <li class=" tsd-kind-class tsd-parent-kind-module">
401
401
  <a href="services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
402
402
  </li>
package/docs/classes/services.AbuseReports.html CHANGED
@@ -116,7 +116,7 @@
116
116
  <li class="tsd-description">
117
117
  <aside class="tsd-sources">
118
118
  <ul>
119
- <li>Defined in services.ts:14</li>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L14">services.ts:14</a></li>
120
120
  </ul>
121
121
  </aside>
122
122
  <div class="tsd-comment tsd-typography">
@@ -147,7 +147,7 @@
147
147
  <li class="tsd-description">
148
148
  <aside class="tsd-sources">
149
149
  <ul>
150
- <li>Defined in services.ts:20</li>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L20">services.ts:20</a></li>
151
151
  </ul>
152
152
  </aside>
153
153
  <div class="tsd-comment tsd-typography">
@@ -175,7 +175,7 @@
175
175
  <li class="tsd-description">
176
176
  <aside class="tsd-sources">
177
177
  <ul>
178
- <li>Defined in services.ts:33</li>
178
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L33">services.ts:33</a></li>
179
179
  </ul>
180
180
  </aside>
181
181
  <div class="tsd-comment tsd-typography">
@@ -235,6 +235,9 @@
235
235
  </li>
236
236
  </ul>
237
237
  <ul class="after-current">
238
+ <li class=" tsd-kind-class tsd-parent-kind-module">
239
+ <a href="services.AgentIngresses.html" class="tsd-kind-icon">Agent<wbr>Ingresses</a>
240
+ </li>
238
241
  <li class=" tsd-kind-class tsd-parent-kind-module">
239
242
  <a href="services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
240
243
  </li>
@@ -301,9 +304,6 @@
301
304
  <li class=" tsd-kind-class tsd-parent-kind-module">
302
305
  <a href="services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
303
306
  </li>
304
- <li class=" tsd-kind-class tsd-parent-kind-module">
305
- <a href="services.IPWhitelist.html" class="tsd-kind-icon">IPWhitelist</a>
306
- </li>
307
307
  <li class=" tsd-kind-class tsd-parent-kind-module">
308
308
  <a href="services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
309
309
  </li>