@ngrok/ngrok-api 0.2.0 → 0.8.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 (244) hide show
  1. package/README.md +0 -28
  2. package/docs/CNAME +1 -0
  3. package/docs/assets/js/search.js +1 -1
  4. package/docs/classes/client.Ngrok.html +204 -119
  5. package/docs/classes/services.APIKeys.html +6 -105
  6. package/docs/classes/services.AbuseReports.html +3 -102
  7. package/docs/classes/{services.IPWhitelist.html → services.AgentIngresses.html} +41 -148
  8. package/docs/classes/services.CertificateAuthorities.html +6 -105
  9. package/docs/classes/services.Credentials.html +6 -105
  10. package/docs/classes/services.EdgeRouteBackendModule.html +270 -0
  11. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +270 -0
  12. package/docs/classes/services.EdgeRouteCompressionModule.html +270 -0
  13. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +270 -0
  14. package/docs/classes/services.EdgeRouteOAuthModule.html +270 -0
  15. package/docs/classes/services.EdgeRouteOIDCModule.html +270 -0
  16. package/docs/classes/{services.EndpointResponseHeadersModule.html → services.EdgeRouteRequestHeadersModule.html} +28 -127
  17. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +270 -0
  18. package/docs/classes/services.EdgeRouteSAMLModule.html +270 -0
  19. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +270 -0
  20. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +270 -0
  21. package/docs/classes/services.EdgesHTTPS.html +343 -0
  22. package/docs/classes/services.EdgesHTTPSRoutes.html +317 -0
  23. package/docs/classes/services.EdgesTCP.html +343 -0
  24. package/docs/classes/services.EdgesTLS.html +343 -0
  25. package/docs/classes/services.Endpoints.html +256 -0
  26. package/docs/classes/services.EventDestinations.html +7 -106
  27. package/docs/classes/services.EventSources.html +6 -105
  28. package/docs/classes/services.EventSubscriptions.html +6 -105
  29. package/docs/classes/{services.EventStreams.html → services.FailoverBackends.html} +51 -140
  30. package/docs/classes/services.HTTPResponseBackends.html +318 -0
  31. package/docs/classes/{services.EndpointMutualTLSModule.html → services.HTTPSEdgeMutualTLSModule.html} +22 -121
  32. package/docs/classes/{services.EndpointTLSTerminationModule.html → services.HTTPSEdgeTLSTerminationModule.html} +22 -121
  33. package/docs/classes/services.IPPolicies.html +6 -105
  34. package/docs/classes/services.IPPolicyRules.html +6 -105
  35. package/docs/classes/services.IPRestrictions.html +7 -106
  36. package/docs/classes/services.ReservedAddrs.html +6 -137
  37. package/docs/classes/services.ReservedDomains.html +8 -171
  38. package/docs/classes/services.SSHCertificateAuthorities.html +6 -105
  39. package/docs/classes/services.SSHCredentials.html +6 -105
  40. package/docs/classes/services.SSHHostCertificates.html +6 -105
  41. package/docs/classes/services.SSHUserCertificates.html +6 -105
  42. package/docs/classes/{services.EndpointSAMLModule.html → services.TCPEdgeBackendModule.html} +25 -124
  43. package/docs/classes/{services.EndpointIPPolicyModule.html → services.TCPEdgeIPRestrictionModule.html} +22 -121
  44. package/docs/classes/services.TLSCertificates.html +6 -105
  45. package/docs/classes/{services.EndpointLoggingModule.html → services.TLSEdgeBackendModule.html} +25 -124
  46. package/docs/classes/{services.EndpointOIDCModule.html → services.TLSEdgeIPRestrictionModule.html} +25 -124
  47. package/docs/classes/{services.EndpointOAuthModule.html → services.TLSEdgeMutualTLSModule.html} +25 -124
  48. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +270 -0
  49. package/docs/classes/services.TunnelGroupBackends.html +351 -0
  50. package/docs/classes/services.TunnelSessions.html +6 -105
  51. package/docs/classes/services.Tunnels.html +34 -101
  52. package/docs/classes/services.WeightedBackends.html +353 -0
  53. package/docs/index.html +0 -27
  54. package/docs/interfaces/client.NgrokConfig.html +2 -2
  55. package/docs/interfaces/datatypes.APIKey.html +6 -6
  56. package/docs/interfaces/datatypes.APIKeyCreate.html +2 -2
  57. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  58. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  59. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  60. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  61. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  62. package/docs/interfaces/datatypes.AbuseReport.html +7 -7
  63. package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
  64. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  65. package/docs/interfaces/{datatypes.EventStream.html → datatypes.AgentIngress.html} +52 -71
  66. package/docs/interfaces/datatypes.AgentIngressCreate.html +205 -0
  67. package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
  68. package/docs/interfaces/{datatypes.IPWhitelistEntryUpdate.html → datatypes.AgentIngressUpdate.html} +16 -16
  69. package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
  70. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
  71. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  72. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  73. package/docs/interfaces/datatypes.Credential.html +7 -7
  74. package/docs/interfaces/datatypes.CredentialCreate.html +3 -3
  75. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  76. package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
  77. package/docs/interfaces/{datatypes.EndpointCircuitBreakerReplace.html → datatypes.EdgeBackendReplace.html} +12 -12
  78. package/docs/interfaces/{datatypes.EndpointIPPolicyReplace.html → datatypes.EdgeIPRestrictionReplace.html} +11 -11
  79. package/docs/interfaces/{datatypes.EndpointMutualTLSReplace.html → datatypes.EdgeMutualTLSReplace.html} +11 -11
  80. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +190 -0
  81. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +190 -0
  82. package/docs/interfaces/{datatypes.EndpointCompressionReplace.html → datatypes.EdgeRouteCompressionReplace.html} +25 -11
  83. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +190 -0
  84. package/docs/interfaces/{datatypes.ReservedDomainCertNSTarget.html → datatypes.EdgeRouteItem.html} +19 -19
  85. package/docs/interfaces/{datatypes.EndpointOAuthReplace.html → datatypes.EdgeRouteOAuthReplace.html} +25 -11
  86. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +190 -0
  87. package/docs/interfaces/{datatypes.EndpointRequestHeadersReplace.html → datatypes.EdgeRouteRequestHeadersReplace.html} +25 -11
  88. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +190 -0
  89. package/docs/interfaces/{datatypes.EndpointSAMLReplace.html → datatypes.EdgeRouteSAMLReplace.html} +25 -11
  90. package/docs/interfaces/{datatypes.EndpointWebhookValidationReplace.html → datatypes.EdgeRouteWebhookVerificationReplace.html} +25 -11
  91. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +190 -0
  92. package/docs/interfaces/{datatypes.EndpointResponseHeadersReplace.html → datatypes.EdgeTLSTerminationAtEdgeReplace.html} +12 -12
  93. package/docs/interfaces/{datatypes.EndpointTLSTerminationReplace.html → datatypes.EdgeTLSTerminationReplace.html} +11 -11
  94. package/docs/interfaces/datatypes.Endpoint.html +395 -0
  95. package/docs/interfaces/{datatypes.EndpointLogging.html → datatypes.EndpointBackend.html} +19 -19
  96. package/docs/interfaces/{datatypes.EndpointLoggingMutate.html → datatypes.EndpointBackendMutate.html} +19 -19
  97. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  98. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  99. package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
  100. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  101. package/docs/interfaces/{datatypes.EndpointConfigurationList.html → datatypes.EndpointList.html} +19 -19
  102. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  103. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  104. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  105. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  106. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
  107. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  108. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  109. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +4 -4
  110. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  111. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  112. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  113. package/docs/interfaces/datatypes.EndpointSAML.html +33 -14
  114. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +28 -9
  115. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  116. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +186 -0
  117. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
  118. package/docs/interfaces/{datatypes.EndpointOIDCReplace.html → datatypes.EndpointWebsocketTCPConverter.html} +16 -25
  119. package/docs/interfaces/datatypes.Error.html +4 -4
  120. package/docs/interfaces/datatypes.EventDestination.html +7 -7
  121. package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
  122. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  123. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  124. package/docs/interfaces/datatypes.EventSource.html +2 -2
  125. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  126. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  127. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  128. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  129. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  130. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  131. package/docs/interfaces/datatypes.EventSubscription.html +7 -7
  132. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +5 -5
  133. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  134. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +6 -6
  135. package/docs/interfaces/datatypes.EventTarget.html +3 -3
  136. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  137. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  138. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  139. package/docs/interfaces/{datatypes.IPWhitelistEntry.html → datatypes.FailoverBackend.html} +41 -41
  140. package/docs/interfaces/{datatypes.IPWhitelistEntryCreate.html → datatypes.FailoverBackendCreate.html} +23 -23
  141. package/docs/interfaces/datatypes.FailoverBackendList.html +205 -0
  142. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +219 -0
  143. package/docs/interfaces/datatypes.HTTPResponseBackend.html +295 -0
  144. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +243 -0
  145. package/docs/interfaces/datatypes.HTTPResponseBackendList.html +190 -0
  146. package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +257 -0
  147. package/docs/interfaces/datatypes.HTTPSEdge.html +314 -0
  148. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +238 -0
  149. package/docs/interfaces/datatypes.HTTPSEdgeList.html +205 -0
  150. package/docs/interfaces/{datatypes.EndpointConfigurationUpdate.html → datatypes.HTTPSEdgeRoute.html} +154 -78
  151. package/docs/interfaces/{datatypes.EndpointConfigurationCreate.html → datatypes.HTTPSEdgeRouteCreate.html} +108 -89
  152. package/docs/interfaces/{datatypes.EndpointConfiguration.html → datatypes.HTTPSEdgeRouteUpdate.html} +104 -123
  153. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +257 -0
  154. package/docs/interfaces/datatypes.IPPolicy.html +5 -24
  155. package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -21
  156. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  157. package/docs/interfaces/datatypes.IPPolicyRule.html +26 -7
  158. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +23 -4
  159. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  160. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  161. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  162. package/docs/interfaces/datatypes.IPRestriction.html +8 -8
  163. package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
  164. package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
  165. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  166. package/docs/interfaces/datatypes.Item.html +1 -1
  167. package/docs/interfaces/datatypes.Paging.html +2 -2
  168. package/docs/interfaces/datatypes.Ref.html +2 -2
  169. package/docs/interfaces/datatypes.ReservedAddr.html +7 -26
  170. package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -22
  171. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  172. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -22
  173. package/docs/interfaces/datatypes.ReservedDomain.html +30 -49
  174. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -23
  175. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  176. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
  177. package/docs/interfaces/datatypes.ReservedDomainCreate.html +6 -44
  178. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  179. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -43
  180. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
  181. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
  182. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  183. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  184. package/docs/interfaces/datatypes.SSHCredential.html +7 -7
  185. package/docs/interfaces/datatypes.SSHCredentialCreate.html +4 -4
  186. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  187. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
  188. package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
  189. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
  190. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  191. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  192. package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
  193. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
  194. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  195. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  196. package/docs/interfaces/datatypes.TCPEdge.html +295 -0
  197. package/docs/interfaces/datatypes.TCPEdgeCreate.html +238 -0
  198. package/docs/interfaces/{datatypes.IPWhitelistEntryList.html → datatypes.TCPEdgeList.html} +22 -22
  199. package/docs/interfaces/{datatypes.EventStreamUpdate.html → datatypes.TCPEdgeUpdate.html} +43 -48
  200. package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
  201. package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
  202. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  203. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  204. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  205. package/docs/interfaces/datatypes.TLSEdge.html +323 -0
  206. package/docs/interfaces/datatypes.TLSEdgeCreate.html +266 -0
  207. package/docs/interfaces/{datatypes.EventStreamList.html → datatypes.TLSEdgeList.html} +23 -23
  208. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +285 -0
  209. package/docs/interfaces/datatypes.Tunnel.html +85 -9
  210. package/docs/interfaces/datatypes.TunnelGroupBackend.html +281 -0
  211. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +205 -0
  212. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +205 -0
  213. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +219 -0
  214. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  215. package/docs/interfaces/datatypes.TunnelSession.html +10 -10
  216. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  217. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  218. package/docs/interfaces/{datatypes.EventStreamCreate.html → datatypes.WeightedBackend.html} +44 -44
  219. package/docs/interfaces/datatypes.WeightedBackendCreate.html +205 -0
  220. package/docs/interfaces/datatypes.WeightedBackendList.html +205 -0
  221. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +219 -0
  222. package/docs/modules/datatypes.html +213 -89
  223. package/docs/modules/services.html +89 -33
  224. package/lib/client.d.ts +54 -24
  225. package/lib/client.d.ts.map +1 -1
  226. package/lib/client.js +45 -22
  227. package/lib/client.js.map +1 -1
  228. package/lib/datatypes.d.ts +617 -281
  229. package/lib/datatypes.d.ts.map +1 -1
  230. package/lib/services.d.ts +385 -169
  231. package/lib/services.d.ts.map +1 -1
  232. package/lib/services.js +1432 -597
  233. package/lib/services.js.map +1 -1
  234. package/package.json +2 -2
  235. package/src/client.ts +98 -45
  236. package/src/datatypes.ts +669 -302
  237. package/src/services.ts +1426 -610
  238. package/docs/classes/services.EndpointCircuitBreakerModule.html +0 -369
  239. package/docs/classes/services.EndpointCompressionModule.html +0 -369
  240. package/docs/classes/services.EndpointConfigurations.html +0 -451
  241. package/docs/classes/services.EndpointRequestHeadersModule.html +0 -369
  242. package/docs/classes/services.EndpointWebhookValidationModule.html +0 -369
  243. package/docs/interfaces/datatypes.EndpointLoggingReplace.html +0 -176
  244. package/test/endpointConfigurations.test.js +0 -67
package/docs/classes/services.IPRestrictions.html CHANGED
@@ -72,7 +72,7 @@
72
72
  <div class="tsd-comment tsd-typography">
73
73
  <div class="lead">
74
74
  <p>An IP restriction is a restriction placed on the CIDRs that are allowed to
75
- initate traffic to a specific aspect of your ngrok account. An IP
75
+ initiate traffic to a specific aspect of your ngrok account. An IP
76
76
  restriction has a type which defines the ingress it applies to. IP
77
77
  restrictions can be used to enforce the source IPs that can make API
78
78
  requests, log in to the dashboard, start ngrok agents, and connect to your
@@ -123,7 +123,7 @@
123
123
  <li class="tsd-description">
124
124
  <aside class="tsd-sources">
125
125
  <ul>
126
- <li>Defined in services.ts:1028</li>
126
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2379">services.ts:2379</a></li>
127
127
  </ul>
128
128
  </aside>
129
129
  <div class="tsd-comment tsd-typography">
@@ -154,7 +154,7 @@
154
154
  <li class="tsd-description">
155
155
  <aside class="tsd-sources">
156
156
  <ul>
157
- <li>Defined in services.ts:1034</li>
157
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2385">services.ts:2385</a></li>
158
158
  </ul>
159
159
  </aside>
160
160
  <div class="tsd-comment tsd-typography">
@@ -182,7 +182,7 @@
182
182
  <li class="tsd-description">
183
183
  <aside class="tsd-sources">
184
184
  <ul>
185
- <li>Defined in services.ts:1047</li>
185
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2398">services.ts:2398</a></li>
186
186
  </ul>
187
187
  </aside>
188
188
  <div class="tsd-comment tsd-typography">
@@ -210,7 +210,7 @@
210
210
  <li class="tsd-description">
211
211
  <aside class="tsd-sources">
212
212
  <ul>
213
- <li>Defined in services.ts:1058</li>
213
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2409">services.ts:2409</a></li>
214
214
  </ul>
215
215
  </aside>
216
216
  <div class="tsd-comment tsd-typography">
@@ -238,7 +238,7 @@
238
238
  <li class="tsd-description">
239
239
  <aside class="tsd-sources">
240
240
  <ul>
241
- <li>Defined in services.ts:1069</li>
241
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2420">services.ts:2420</a></li>
242
242
  </ul>
243
243
  </aside>
244
244
  <div class="tsd-comment tsd-typography">
@@ -260,7 +260,7 @@
260
260
  <li class="tsd-description">
261
261
  <aside class="tsd-sources">
262
262
  <ul>
263
- <li>Defined in services.ts:1111</li>
263
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2462">services.ts:2462</a></li>
264
264
  </ul>
265
265
  </aside>
266
266
  <div class="tsd-comment tsd-typography">
@@ -299,75 +299,6 @@
299
299
  </nav>
300
300
  <nav class="tsd-navigation secondary menu-sticky">
301
301
  <ul class="before-current">
302
- <li class=" tsd-kind-class tsd-parent-kind-module">
303
- <a href="services.APIKeys.html" class="tsd-kind-icon">APIKeys</a>
304
- </li>
305
- <li class=" tsd-kind-class tsd-parent-kind-module">
306
- <a href="services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
307
- </li>
308
- <li class=" tsd-kind-class tsd-parent-kind-module">
309
- <a href="services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
310
- </li>
311
- <li class=" tsd-kind-class tsd-parent-kind-module">
312
- <a href="services.Credentials.html" class="tsd-kind-icon">Credentials</a>
313
- </li>
314
- <li class=" tsd-kind-class tsd-parent-kind-module">
315
- <a href="services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a>
316
- </li>
317
- <li class=" tsd-kind-class tsd-parent-kind-module">
318
- <a href="services.EndpointCompressionModule.html" class="tsd-kind-icon">Endpoint<wbr>Compression<wbr>Module</a>
319
- </li>
320
- <li class=" tsd-kind-class tsd-parent-kind-module">
321
- <a href="services.EndpointConfigurations.html" class="tsd-kind-icon">Endpoint<wbr>Configurations</a>
322
- </li>
323
- <li class=" tsd-kind-class tsd-parent-kind-module">
324
- <a href="services.EndpointIPPolicyModule.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Module</a>
325
- </li>
326
- <li class=" tsd-kind-class tsd-parent-kind-module">
327
- <a href="services.EndpointLoggingModule.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Module</a>
328
- </li>
329
- <li class=" tsd-kind-class tsd-parent-kind-module">
330
- <a href="services.EndpointMutualTLSModule.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSModule</a>
331
- </li>
332
- <li class=" tsd-kind-class tsd-parent-kind-module">
333
- <a href="services.EndpointOAuthModule.html" class="tsd-kind-icon">EndpointOAuth<wbr>Module</a>
334
- </li>
335
- <li class=" tsd-kind-class tsd-parent-kind-module">
336
- <a href="services.EndpointOIDCModule.html" class="tsd-kind-icon">EndpointOIDCModule</a>
337
- </li>
338
- <li class=" tsd-kind-class tsd-parent-kind-module">
339
- <a href="services.EndpointRequestHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers<wbr>Module</a>
340
- </li>
341
- <li class=" tsd-kind-class tsd-parent-kind-module">
342
- <a href="services.EndpointResponseHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers<wbr>Module</a>
343
- </li>
344
- <li class=" tsd-kind-class tsd-parent-kind-module">
345
- <a href="services.EndpointSAMLModule.html" class="tsd-kind-icon">EndpointSAMLModule</a>
346
- </li>
347
- <li class=" tsd-kind-class tsd-parent-kind-module">
348
- <a href="services.EndpointTLSTerminationModule.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>Module</a>
349
- </li>
350
- <li class=" tsd-kind-class tsd-parent-kind-module">
351
- <a href="services.EndpointWebhookValidationModule.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation<wbr>Module</a>
352
- </li>
353
- <li class=" tsd-kind-class tsd-parent-kind-module">
354
- <a href="services.EventDestinations.html" class="tsd-kind-icon">Event<wbr>Destinations</a>
355
- </li>
356
- <li class=" tsd-kind-class tsd-parent-kind-module">
357
- <a href="services.EventSources.html" class="tsd-kind-icon">Event<wbr>Sources</a>
358
- </li>
359
- <li class=" tsd-kind-class tsd-parent-kind-module">
360
- <a href="services.EventStreams.html" class="tsd-kind-icon">Event<wbr>Streams</a>
361
- </li>
362
- <li class=" tsd-kind-class tsd-parent-kind-module">
363
- <a href="services.EventSubscriptions.html" class="tsd-kind-icon">Event<wbr>Subscriptions</a>
364
- </li>
365
- <li class=" tsd-kind-class tsd-parent-kind-module">
366
- <a href="services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a>
367
- </li>
368
- <li class=" tsd-kind-class tsd-parent-kind-module">
369
- <a href="services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a>
370
- </li>
371
302
  </ul>
372
303
  <ul class="current">
373
304
  <li class="current tsd-kind-class tsd-parent-kind-module">
@@ -395,36 +326,6 @@
395
326
  </li>
396
327
  </ul>
397
328
  <ul class="after-current">
398
- <li class=" tsd-kind-class tsd-parent-kind-module">
399
- <a href="services.IPWhitelist.html" class="tsd-kind-icon">IPWhitelist</a>
400
- </li>
401
- <li class=" tsd-kind-class tsd-parent-kind-module">
402
- <a href="services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
403
- </li>
404
- <li class=" tsd-kind-class tsd-parent-kind-module">
405
- <a href="services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a>
406
- </li>
407
- <li class=" tsd-kind-class tsd-parent-kind-module">
408
- <a href="services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a>
409
- </li>
410
- <li class=" tsd-kind-class tsd-parent-kind-module">
411
- <a href="services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a>
412
- </li>
413
- <li class=" tsd-kind-class tsd-parent-kind-module">
414
- <a href="services.SSHHostCertificates.html" class="tsd-kind-icon">SSHHost<wbr>Certificates</a>
415
- </li>
416
- <li class=" tsd-kind-class tsd-parent-kind-module">
417
- <a href="services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a>
418
- </li>
419
- <li class=" tsd-kind-class tsd-parent-kind-module">
420
- <a href="services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a>
421
- </li>
422
- <li class=" tsd-kind-class tsd-parent-kind-module">
423
- <a href="services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a>
424
- </li>
425
- <li class=" tsd-kind-class tsd-parent-kind-module">
426
- <a href="services.Tunnels.html" class="tsd-kind-icon">Tunnels</a>
427
- </li>
428
329
  </ul>
429
330
  </nav>
430
331
  </div>
package/docs/classes/services.ReservedAddrs.html CHANGED
@@ -100,7 +100,6 @@
100
100
  <ul class="tsd-index-list">
101
101
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.ReservedAddrs.html#create" class="tsd-kind-icon">create</a></li>
102
102
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.ReservedAddrs.html#delete" class="tsd-kind-icon">delete</a></li>
103
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.ReservedAddrs.html#deleteEndpointConfig" class="tsd-kind-icon">delete<wbr>Endpoint<wbr>Config</a></li>
104
103
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.ReservedAddrs.html#get" class="tsd-kind-icon">get</a></li>
105
104
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.ReservedAddrs.html#list" class="tsd-kind-icon">list</a></li>
106
105
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.ReservedAddrs.html#update" class="tsd-kind-icon">update</a></li>
@@ -121,7 +120,7 @@
121
120
  <li class="tsd-description">
122
121
  <aside class="tsd-sources">
123
122
  <ul>
124
- <li>Defined in services.ts:1643</li>
123
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2482">services.ts:2482</a></li>
125
124
  </ul>
126
125
  </aside>
127
126
  <div class="tsd-comment tsd-typography">
@@ -152,7 +151,7 @@
152
151
  <li class="tsd-description">
153
152
  <aside class="tsd-sources">
154
153
  <ul>
155
- <li>Defined in services.ts:1649</li>
154
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2488">services.ts:2488</a></li>
156
155
  </ul>
157
156
  </aside>
158
157
  <div class="tsd-comment tsd-typography">
@@ -180,7 +179,7 @@
180
179
  <li class="tsd-description">
181
180
  <aside class="tsd-sources">
182
181
  <ul>
183
- <li>Defined in services.ts:1662</li>
182
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2501">services.ts:2501</a></li>
184
183
  </ul>
185
184
  </aside>
186
185
  <div class="tsd-comment tsd-typography">
@@ -198,34 +197,6 @@
198
197
  </li>
199
198
  </ul>
200
199
  </section>
201
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
202
- <a name="deleteEndpointConfig" class="tsd-anchor"></a>
203
- <h3>delete<wbr>Endpoint<wbr>Config</h3>
204
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
205
- <li class="tsd-signature tsd-kind-icon">delete<wbr>Endpoint<wbr>Config<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
206
- </ul>
207
- <ul class="tsd-descriptions">
208
- <li class="tsd-description">
209
- <aside class="tsd-sources">
210
- <ul>
211
- <li>Defined in services.ts:1739</li>
212
- </ul>
213
- </aside>
214
- <div class="tsd-comment tsd-typography">
215
- <div class="lead">
216
- <p>Detach the endpoint configuration attached to a reserved address.</p>
217
- </div>
218
- </div>
219
- <h4 class="tsd-parameters-title">Parameters</h4>
220
- <ul class="tsd-parameters">
221
- <li>
222
- <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
223
- </li>
224
- </ul>
225
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
226
- </li>
227
- </ul>
228
- </section>
229
200
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
230
201
  <a name="get" class="tsd-anchor"></a>
231
202
  <h3>get</h3>
@@ -236,7 +207,7 @@
236
207
  <li class="tsd-description">
237
208
  <aside class="tsd-sources">
238
209
  <ul>
239
- <li>Defined in services.ts:1673</li>
210
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2512">services.ts:2512</a></li>
240
211
  </ul>
241
212
  </aside>
242
213
  <div class="tsd-comment tsd-typography">
@@ -264,7 +235,7 @@
264
235
  <li class="tsd-description">
265
236
  <aside class="tsd-sources">
266
237
  <ul>
267
- <li>Defined in services.ts:1684</li>
238
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2523">services.ts:2523</a></li>
268
239
  </ul>
269
240
  </aside>
270
241
  <div class="tsd-comment tsd-typography">
@@ -286,7 +257,7 @@
286
257
  <li class="tsd-description">
287
258
  <aside class="tsd-sources">
288
259
  <ul>
289
- <li>Defined in services.ts:1726</li>
260
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2565">services.ts:2565</a></li>
290
261
  </ul>
291
262
  </aside>
292
263
  <div class="tsd-comment tsd-typography">
@@ -325,81 +296,6 @@
325
296
  </nav>
326
297
  <nav class="tsd-navigation secondary menu-sticky">
327
298
  <ul class="before-current">
328
- <li class=" tsd-kind-class tsd-parent-kind-module">
329
- <a href="services.APIKeys.html" class="tsd-kind-icon">APIKeys</a>
330
- </li>
331
- <li class=" tsd-kind-class tsd-parent-kind-module">
332
- <a href="services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
333
- </li>
334
- <li class=" tsd-kind-class tsd-parent-kind-module">
335
- <a href="services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
336
- </li>
337
- <li class=" tsd-kind-class tsd-parent-kind-module">
338
- <a href="services.Credentials.html" class="tsd-kind-icon">Credentials</a>
339
- </li>
340
- <li class=" tsd-kind-class tsd-parent-kind-module">
341
- <a href="services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a>
342
- </li>
343
- <li class=" tsd-kind-class tsd-parent-kind-module">
344
- <a href="services.EndpointCompressionModule.html" class="tsd-kind-icon">Endpoint<wbr>Compression<wbr>Module</a>
345
- </li>
346
- <li class=" tsd-kind-class tsd-parent-kind-module">
347
- <a href="services.EndpointConfigurations.html" class="tsd-kind-icon">Endpoint<wbr>Configurations</a>
348
- </li>
349
- <li class=" tsd-kind-class tsd-parent-kind-module">
350
- <a href="services.EndpointIPPolicyModule.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Module</a>
351
- </li>
352
- <li class=" tsd-kind-class tsd-parent-kind-module">
353
- <a href="services.EndpointLoggingModule.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Module</a>
354
- </li>
355
- <li class=" tsd-kind-class tsd-parent-kind-module">
356
- <a href="services.EndpointMutualTLSModule.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSModule</a>
357
- </li>
358
- <li class=" tsd-kind-class tsd-parent-kind-module">
359
- <a href="services.EndpointOAuthModule.html" class="tsd-kind-icon">EndpointOAuth<wbr>Module</a>
360
- </li>
361
- <li class=" tsd-kind-class tsd-parent-kind-module">
362
- <a href="services.EndpointOIDCModule.html" class="tsd-kind-icon">EndpointOIDCModule</a>
363
- </li>
364
- <li class=" tsd-kind-class tsd-parent-kind-module">
365
- <a href="services.EndpointRequestHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers<wbr>Module</a>
366
- </li>
367
- <li class=" tsd-kind-class tsd-parent-kind-module">
368
- <a href="services.EndpointResponseHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers<wbr>Module</a>
369
- </li>
370
- <li class=" tsd-kind-class tsd-parent-kind-module">
371
- <a href="services.EndpointSAMLModule.html" class="tsd-kind-icon">EndpointSAMLModule</a>
372
- </li>
373
- <li class=" tsd-kind-class tsd-parent-kind-module">
374
- <a href="services.EndpointTLSTerminationModule.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>Module</a>
375
- </li>
376
- <li class=" tsd-kind-class tsd-parent-kind-module">
377
- <a href="services.EndpointWebhookValidationModule.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation<wbr>Module</a>
378
- </li>
379
- <li class=" tsd-kind-class tsd-parent-kind-module">
380
- <a href="services.EventDestinations.html" class="tsd-kind-icon">Event<wbr>Destinations</a>
381
- </li>
382
- <li class=" tsd-kind-class tsd-parent-kind-module">
383
- <a href="services.EventSources.html" class="tsd-kind-icon">Event<wbr>Sources</a>
384
- </li>
385
- <li class=" tsd-kind-class tsd-parent-kind-module">
386
- <a href="services.EventStreams.html" class="tsd-kind-icon">Event<wbr>Streams</a>
387
- </li>
388
- <li class=" tsd-kind-class tsd-parent-kind-module">
389
- <a href="services.EventSubscriptions.html" class="tsd-kind-icon">Event<wbr>Subscriptions</a>
390
- </li>
391
- <li class=" tsd-kind-class tsd-parent-kind-module">
392
- <a href="services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a>
393
- </li>
394
- <li class=" tsd-kind-class tsd-parent-kind-module">
395
- <a href="services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a>
396
- </li>
397
- <li class=" tsd-kind-class tsd-parent-kind-module">
398
- <a href="services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
399
- </li>
400
- <li class=" tsd-kind-class tsd-parent-kind-module">
401
- <a href="services.IPWhitelist.html" class="tsd-kind-icon">IPWhitelist</a>
402
- </li>
403
299
  </ul>
404
300
  <ul class="current">
405
301
  <li class="current tsd-kind-class tsd-parent-kind-module">
@@ -414,9 +310,6 @@
414
310
  <li class=" tsd-kind-method tsd-parent-kind-class">
415
311
  <a href="services.ReservedAddrs.html#delete" class="tsd-kind-icon">delete</a>
416
312
  </li>
417
- <li class=" tsd-kind-method tsd-parent-kind-class">
418
- <a href="services.ReservedAddrs.html#deleteEndpointConfig" class="tsd-kind-icon">delete<wbr>Endpoint<wbr>Config</a>
419
- </li>
420
313
  <li class=" tsd-kind-method tsd-parent-kind-class">
421
314
  <a href="services.ReservedAddrs.html#get" class="tsd-kind-icon">get</a>
422
315
  </li>
@@ -430,30 +323,6 @@
430
323
  </li>
431
324
  </ul>
432
325
  <ul class="after-current">
433
- <li class=" tsd-kind-class tsd-parent-kind-module">
434
- <a href="services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a>
435
- </li>
436
- <li class=" tsd-kind-class tsd-parent-kind-module">
437
- <a href="services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a>
438
- </li>
439
- <li class=" tsd-kind-class tsd-parent-kind-module">
440
- <a href="services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a>
441
- </li>
442
- <li class=" tsd-kind-class tsd-parent-kind-module">
443
- <a href="services.SSHHostCertificates.html" class="tsd-kind-icon">SSHHost<wbr>Certificates</a>
444
- </li>
445
- <li class=" tsd-kind-class tsd-parent-kind-module">
446
- <a href="services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a>
447
- </li>
448
- <li class=" tsd-kind-class tsd-parent-kind-module">
449
- <a href="services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a>
450
- </li>
451
- <li class=" tsd-kind-class tsd-parent-kind-module">
452
- <a href="services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a>
453
- </li>
454
- <li class=" tsd-kind-class tsd-parent-kind-module">
455
- <a href="services.Tunnels.html" class="tsd-kind-icon">Tunnels</a>
456
- </li>
457
326
  </ul>
458
327
  </nav>
459
328
  </div>