@ngrok/ngrok-api 0.8.0 → 0.9.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 (229) hide show
  1. package/README.md +21 -16
  2. package/docs/classes/client.Ngrok.html +25 -25
  3. package/docs/classes/services.APIKeys.html +6 -6
  4. package/docs/classes/services.AbuseReports.html +3 -3
  5. package/docs/classes/services.AgentIngresses.html +6 -6
  6. package/docs/classes/services.CertificateAuthorities.html +6 -6
  7. package/docs/classes/services.Credentials.html +6 -6
  8. package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
  9. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
  10. package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
  11. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
  12. package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
  13. package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
  14. package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
  15. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
  16. package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
  17. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
  18. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
  19. package/docs/classes/services.EdgesHTTPS.html +6 -6
  20. package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
  21. package/docs/classes/services.EdgesTCP.html +6 -6
  22. package/docs/classes/services.EdgesTLS.html +6 -6
  23. package/docs/classes/services.Endpoints.html +3 -3
  24. package/docs/classes/services.EventDestinations.html +6 -6
  25. package/docs/classes/services.EventSources.html +6 -6
  26. package/docs/classes/services.EventSubscriptions.html +6 -6
  27. package/docs/classes/services.FailoverBackends.html +7 -7
  28. package/docs/classes/services.HTTPResponseBackends.html +6 -6
  29. package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +4 -4
  30. package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +4 -4
  31. package/docs/classes/services.IPPolicies.html +6 -6
  32. package/docs/classes/services.IPPolicyRules.html +6 -6
  33. package/docs/classes/services.IPRestrictions.html +6 -6
  34. package/docs/classes/services.ReservedAddrs.html +6 -6
  35. package/docs/classes/services.ReservedDomains.html +8 -8
  36. package/docs/classes/services.SSHCertificateAuthorities.html +6 -6
  37. package/docs/classes/services.SSHCredentials.html +6 -6
  38. package/docs/classes/services.SSHHostCertificates.html +6 -6
  39. package/docs/classes/services.SSHUserCertificates.html +6 -6
  40. package/docs/classes/services.TCPEdgeBackendModule.html +4 -4
  41. package/docs/classes/services.TCPEdgeIPRestrictionModule.html +4 -4
  42. package/docs/classes/services.TLSCertificates.html +6 -6
  43. package/docs/classes/services.TLSEdgeBackendModule.html +4 -4
  44. package/docs/classes/services.TLSEdgeIPRestrictionModule.html +4 -4
  45. package/docs/classes/services.TLSEdgeMutualTLSModule.html +4 -4
  46. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +4 -4
  47. package/docs/classes/services.TunnelGroupBackends.html +7 -7
  48. package/docs/classes/services.TunnelSessions.html +6 -6
  49. package/docs/classes/services.Tunnels.html +3 -3
  50. package/docs/classes/services.WeightedBackends.html +7 -7
  51. package/docs/index.html +22 -16
  52. package/docs/interfaces/client.NgrokConfig.html +2 -2
  53. package/docs/interfaces/datatypes.APIKey.html +6 -6
  54. package/docs/interfaces/datatypes.APIKeyCreate.html +2 -2
  55. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  56. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  57. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  58. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  59. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  60. package/docs/interfaces/datatypes.AbuseReport.html +7 -7
  61. package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
  62. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  63. package/docs/interfaces/datatypes.AgentIngress.html +8 -8
  64. package/docs/interfaces/datatypes.AgentIngressCreate.html +3 -3
  65. package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
  66. package/docs/interfaces/datatypes.AgentIngressUpdate.html +3 -3
  67. package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
  68. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
  69. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  70. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  71. package/docs/interfaces/datatypes.Credential.html +8 -8
  72. package/docs/interfaces/datatypes.CredentialCreate.html +3 -3
  73. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  74. package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
  75. package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
  76. package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
  77. package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
  78. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
  79. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
  80. package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
  81. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
  82. package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
  83. package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
  84. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
  85. package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
  86. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
  87. package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
  88. package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
  89. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
  90. package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
  91. package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
  92. package/docs/interfaces/datatypes.Endpoint.html +13 -13
  93. package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
  94. package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
  95. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  96. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  97. package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
  98. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  99. package/docs/interfaces/datatypes.EndpointList.html +3 -3
  100. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  101. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +3 -3
  102. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  103. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  104. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
  105. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  106. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  107. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +4 -4
  108. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  109. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  110. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  111. package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
  112. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
  113. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  114. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
  115. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +3 -3
  116. package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
  117. package/docs/interfaces/datatypes.Error.html +4 -4
  118. package/docs/interfaces/datatypes.EventDestination.html +7 -7
  119. package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
  120. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  121. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  122. package/docs/interfaces/datatypes.EventSource.html +2 -2
  123. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  124. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  125. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  126. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  127. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  128. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  129. package/docs/interfaces/datatypes.EventSubscription.html +7 -7
  130. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +4 -4
  131. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  132. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
  133. package/docs/interfaces/datatypes.EventTarget.html +3 -3
  134. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  135. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  136. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  137. package/docs/interfaces/datatypes.FailoverBackend.html +6 -6
  138. package/docs/interfaces/datatypes.FailoverBackendCreate.html +3 -3
  139. package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
  140. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
  141. package/docs/interfaces/datatypes.HTTPResponseBackend.html +8 -8
  142. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +5 -5
  143. package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
  144. package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
  145. package/docs/interfaces/datatypes.HTTPSEdge.html +9 -9
  146. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +5 -5
  147. package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
  148. package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +19 -19
  149. package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +16 -16
  150. package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +17 -17
  151. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
  152. package/docs/interfaces/datatypes.IPPolicy.html +5 -5
  153. package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -2
  154. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  155. package/docs/interfaces/datatypes.IPPolicyRule.html +8 -8
  156. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +5 -5
  157. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  158. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  159. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  160. package/docs/interfaces/datatypes.IPRestriction.html +8 -8
  161. package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
  162. package/docs/interfaces/datatypes.IPRestrictionList.html +4 -4
  163. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  164. package/docs/interfaces/datatypes.Item.html +1 -1
  165. package/docs/interfaces/datatypes.Paging.html +2 -2
  166. package/docs/interfaces/datatypes.Ref.html +2 -2
  167. package/docs/interfaces/datatypes.ReservedAddr.html +7 -7
  168. package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -3
  169. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  170. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
  171. package/docs/interfaces/datatypes.ReservedDomain.html +12 -12
  172. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -4
  173. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  174. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
  175. package/docs/interfaces/datatypes.ReservedDomainCreate.html +6 -6
  176. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  177. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
  178. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
  179. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
  180. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  181. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  182. package/docs/interfaces/datatypes.SSHCredential.html +7 -7
  183. package/docs/interfaces/datatypes.SSHCredentialCreate.html +4 -4
  184. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  185. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
  186. package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
  187. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
  188. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  189. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  190. package/docs/interfaces/datatypes.SSHUserCertificate.html +15 -15
  191. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +10 -10
  192. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  193. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  194. package/docs/interfaces/datatypes.TCPEdge.html +8 -8
  195. package/docs/interfaces/datatypes.TCPEdgeCreate.html +5 -5
  196. package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
  197. package/docs/interfaces/datatypes.TCPEdgeUpdate.html +6 -6
  198. package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
  199. package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
  200. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  201. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  202. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  203. package/docs/interfaces/datatypes.TLSEdge.html +10 -10
  204. package/docs/interfaces/datatypes.TLSEdgeCreate.html +7 -7
  205. package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
  206. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +8 -8
  207. package/docs/interfaces/datatypes.Tunnel.html +11 -11
  208. package/docs/interfaces/datatypes.TunnelGroupBackend.html +7 -7
  209. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +3 -3
  210. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
  211. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
  212. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  213. package/docs/interfaces/datatypes.TunnelSession.html +10 -10
  214. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  215. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  216. package/docs/interfaces/datatypes.WeightedBackend.html +7 -7
  217. package/docs/interfaces/datatypes.WeightedBackendCreate.html +4 -4
  218. package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
  219. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +5 -5
  220. package/lib/client.js +1 -1
  221. package/lib/client.js.map +1 -1
  222. package/lib/datatypes.d.ts +8 -8
  223. package/lib/datatypes.d.ts.map +1 -1
  224. package/lib/services.d.ts +3 -3
  225. package/lib/services.js +3 -3
  226. package/package.json +1 -1
  227. package/src/client.ts +1 -1
  228. package/src/datatypes.ts +8 -8
  229. package/src/services.ts +3 -3
@@ -120,7 +120,7 @@
120
120
  <li class="tsd-description">
121
121
  <aside class="tsd-sources">
122
122
  <ul>
123
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3229">services.ts:3229</a></li>
123
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L3229">services.ts:3229</a></li>
124
124
  </ul>
125
125
  </aside>
126
126
  <div class="tsd-comment tsd-typography">
@@ -151,7 +151,7 @@
151
151
  <li class="tsd-description">
152
152
  <aside class="tsd-sources">
153
153
  <ul>
154
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3277">services.ts:3277</a></li>
154
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L3277">services.ts:3277</a></li>
155
155
  </ul>
156
156
  </aside>
157
157
  <div class="tsd-comment tsd-typography">
@@ -179,7 +179,7 @@
179
179
  <li class="tsd-description">
180
180
  <aside class="tsd-sources">
181
181
  <ul>
182
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3235">services.ts:3235</a></li>
182
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L3235">services.ts:3235</a></li>
183
183
  </ul>
184
184
  </aside>
185
185
  <div class="tsd-comment tsd-typography">
@@ -201,7 +201,7 @@
201
201
  <li class="tsd-description">
202
202
  <aside class="tsd-sources">
203
203
  <ul>
204
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3288">services.ts:3288</a></li>
204
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L3288">services.ts:3288</a></li>
205
205
  </ul>
206
206
  </aside>
207
207
  <div class="tsd-comment tsd-typography">
@@ -229,7 +229,7 @@
229
229
  <li class="tsd-description">
230
230
  <aside class="tsd-sources">
231
231
  <ul>
232
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3299">services.ts:3299</a></li>
232
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L3299">services.ts:3299</a></li>
233
233
  </ul>
234
234
  </aside>
235
235
  <div class="tsd-comment tsd-typography">
@@ -257,7 +257,7 @@
257
257
  <li class="tsd-description">
258
258
  <aside class="tsd-sources">
259
259
  <ul>
260
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3310">services.ts:3310</a></li>
260
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L3310">services.ts:3310</a></li>
261
261
  </ul>
262
262
  </aside>
263
263
  <div class="tsd-comment tsd-typography">
@@ -116,7 +116,7 @@
116
116
  <li class="tsd-description">
117
117
  <aside class="tsd-sources">
118
118
  <ul>
119
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3327">services.ts:3327</a></li>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L3327">services.ts:3327</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 <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3373">services.ts:3373</a></li>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L3373">services.ts:3373</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 <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3333">services.ts:3333</a></li>
178
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L3333">services.ts:3333</a></li>
179
179
  </ul>
180
180
  </aside>
181
181
  <div class="tsd-comment tsd-typography">
@@ -121,7 +121,7 @@
121
121
  <li class="tsd-description">
122
122
  <aside class="tsd-sources">
123
123
  <ul>
124
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L538">services.ts:538</a></li>
124
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L538">services.ts:538</a></li>
125
125
  </ul>
126
126
  </aside>
127
127
  <div class="tsd-comment tsd-typography">
@@ -152,7 +152,7 @@
152
152
  <li class="tsd-description">
153
153
  <aside class="tsd-sources">
154
154
  <ul>
155
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L544">services.ts:544</a></li>
155
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L544">services.ts:544</a></li>
156
156
  </ul>
157
157
  </aside>
158
158
  <div class="tsd-comment tsd-typography">
@@ -180,12 +180,12 @@
180
180
  <li class="tsd-description">
181
181
  <aside class="tsd-sources">
182
182
  <ul>
183
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L557">services.ts:557</a></li>
183
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L557">services.ts:557</a></li>
184
184
  </ul>
185
185
  </aside>
186
186
  <div class="tsd-comment tsd-typography">
187
187
  <div class="lead">
188
- <p>Delete a Weighted backend by ID. TODO what if used?</p>
188
+ <p>Delete a Weighted backend by ID.</p>
189
189
  </div>
190
190
  </div>
191
191
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -208,7 +208,7 @@
208
208
  <li class="tsd-description">
209
209
  <aside class="tsd-sources">
210
210
  <ul>
211
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L568">services.ts:568</a></li>
211
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L568">services.ts:568</a></li>
212
212
  </ul>
213
213
  </aside>
214
214
  <div class="tsd-comment tsd-typography">
@@ -236,7 +236,7 @@
236
236
  <li class="tsd-description">
237
237
  <aside class="tsd-sources">
238
238
  <ul>
239
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L579">services.ts:579</a></li>
239
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L579">services.ts:579</a></li>
240
240
  </ul>
241
241
  </aside>
242
242
  <div class="tsd-comment tsd-typography">
@@ -258,7 +258,7 @@
258
258
  <li class="tsd-description">
259
259
  <aside class="tsd-sources">
260
260
  <ul>
261
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L621">services.ts:621</a></li>
261
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L621">services.ts:621</a></li>
262
262
  </ul>
263
263
  </aside>
264
264
  <div class="tsd-comment tsd-typography">
package/docs/index.html CHANGED
@@ -58,6 +58,13 @@
58
58
  <div class="row">
59
59
  <div class="col-8 col-content">
60
60
  <div class="tsd-panel tsd-typography">
61
+ <a href="#unstable" id="unstable" style="color: inherit; text-decoration: none;">
62
+ <h1>Unstable</h1>
63
+ </a>
64
+ <p>This library is currently unstable. We know of rough edges
65
+ and are working to bring it to parity with our other API client
66
+ libraries. Please feel free to try it out and let us know if you find
67
+ it useful!</p>
61
68
  <a href="#ngrok-api-client-library-for-javascript-and-typescript" id="ngrok-api-client-library-for-javascript-and-typescript" style="color: inherit; text-decoration: none;">
62
69
  <h2>ngrok API client library for JavaScript and TypeScript</h2>
63
70
  </a>
@@ -85,12 +92,12 @@
85
92
  <pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Ngrok</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@ngrok/ngrok-api&#039;</span><span style="color: #000000">;</span>
86
93
 
87
94
  <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">ngrok</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Ngrok</span><span style="color: #000000">({</span>
88
- <span style="color: #000000"> </span><span style="color: #001080">apiToken:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;&lt;API KEY&gt;&#039;</span><span style="color: #000000">,</span>
95
+ <span style="color: #000000"> </span><span style="color: #001080">apiToken:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;&lt;API KEY&gt;&#039;</span><span style="color: #000000">,</span>
89
96
  <span style="color: #000000">});</span>
90
97
 
91
98
  <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">domain</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">domains</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">({</span>
92
- <span style="color: #000000"> </span><span style="color: #001080">name:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;your-name.ngrok.io&#039;</span>
93
- <span style="color: #000000">})</span>
99
+ <span style="color: #000000"> </span><span style="color: #001080">name:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;your-name.ngrok.io&#039;</span><span style="color: #000000">,</span>
100
+ <span style="color: #000000">});</span>
94
101
  <span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">domain</span><span style="color: #000000">);</span>
95
102
  </code></pre>
96
103
  <a href="#automatic-paging" id="automatic-paging" style="color: inherit; text-decoration: none;">
@@ -103,7 +110,7 @@
103
110
  <pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Ngrok</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@ngrok/ngrok-api&#039;</span><span style="color: #000000">;</span>
104
111
 
105
112
  <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">ngrok</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Ngrok</span><span style="color: #000000">({</span>
106
- <span style="color: #000000"> </span><span style="color: #001080">apiToken:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;&lt;API KEY&gt;&#039;</span><span style="color: #000000">,</span>
113
+ <span style="color: #000000"> </span><span style="color: #001080">apiToken:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;&lt;API KEY&gt;&#039;</span><span style="color: #000000">,</span>
107
114
  <span style="color: #000000">});</span>
108
115
 
109
116
  <span style="color: #000000">(</span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">tunnels</span><span style="color: #000000">.</span><span style="color: #795E26">list</span><span style="color: #000000">()).</span><span style="color: #795E26">forEach</span><span style="color: #000000">(</span><span style="color: #001080">t</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">t</span><span style="color: #000000">));</span>
@@ -115,13 +122,13 @@
115
122
  programming. You can use callback chaining with <code>.then()</code> and <code>.catch()</code> syntax
116
123
  or the <code>await</code> keyword to wait for completion of an API call.</p>
117
124
  <pre><code class="language-typescript"><span style="color: #008000">// await style</span>
118
- <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">cred</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">credentials</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">({</span><span style="color: #001080">description:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;example&quot;</span><span style="color: #000000">});</span>
125
+ <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">cred</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">credentials</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">({ </span><span style="color: #001080">description:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;example&#039;</span><span style="color: #000000"> });</span>
119
126
  <span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">cred</span><span style="color: #000000">);</span>
120
127
 
121
128
  <span style="color: #008000">// callback chaining</span>
122
- <span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">credentials</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">({</span><span style="color: #001080">description:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;example&quot;</span><span style="color: #000000">}).</span><span style="color: #795E26">then</span><span style="color: #000000">((</span><span style="color: #001080">cred</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
123
- <span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">cred</span><span style="color: #000000">)</span>
124
- <span style="color: #000000">}));</span>
129
+ <span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">credentials</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">({ </span><span style="color: #001080">description:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;example&#039;</span><span style="color: #000000"> }).</span><span style="color: #795E26">then</span><span style="color: #000000">(</span><span style="color: #001080">cred</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
130
+ <span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">cred</span><span style="color: #000000">);</span>
131
+ <span style="color: #000000">});</span>
125
132
  </code></pre>
126
133
  <a href="#error-handling" id="error-handling" style="color: inherit; text-decoration: none;">
127
134
  <h3>Error Handling</h3>
@@ -132,17 +139,16 @@
132
139
  conditions.</p>
133
140
  <p>The <code>Error</code> type includes a <code>statusCode</code> property which can be used to
134
141
  distinguish not found errors when a resource does not exist:</p>
135
- <pre><code class="language-typescript">
136
- <span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Error</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@ngrok/ngrok-api&#039;</span><span style="color: #000000">;</span>
142
+ <pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Error</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@ngrok/ngrok-api&#039;</span><span style="color: #000000">;</span>
137
143
 
138
144
  <span style="color: #AF00DB">try</span><span style="color: #000000"> {</span>
139
145
  <span style="color: #000000"> </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">ipPolicies</span><span style="color: #000000">.</span><span style="color: #795E26">update</span><span style="color: #000000">({</span>
140
146
  <span style="color: #000000"> </span><span style="color: #001080">id:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;someInvalidId&#039;</span><span style="color: #000000">,</span>
141
147
  <span style="color: #000000"> </span><span style="color: #001080">description:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;updated description&#039;</span><span style="color: #000000">,</span>
142
- <span style="color: #000000"> })</span>
148
+ <span style="color: #000000"> });</span>
143
149
  <span style="color: #000000">} </span><span style="color: #AF00DB">catch</span><span style="color: #000000"> (</span><span style="color: #001080">err</span><span style="color: #000000">: </span><span style="color: #267F99">Error</span><span style="color: #000000">) {</span>
144
150
  <span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">err</span><span style="color: #000000">.</span><span style="color: #001080">statusCode</span><span style="color: #000000"> == </span><span style="color: #098658">404</span><span style="color: #000000">) {</span>
145
- <span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;no ip policy with that id to update&#039;</span><span style="color: #000000">)</span>
151
+ <span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;no ip policy with that id to update&#039;</span><span style="color: #000000">);</span>
146
152
  <span style="color: #000000"> }</span>
147
153
  <span style="color: #000000">}</span>
148
154
  </code></pre>
@@ -155,12 +161,12 @@
155
161
  <span style="color: #AF00DB">try</span><span style="color: #000000"> {</span>
156
162
  <span style="color: #000000"> </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">ipPolicies</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">({</span>
157
163
  <span style="color: #000000"> </span><span style="color: #001080">action:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;something invalid&#039;</span><span style="color: #000000">,</span>
158
- <span style="color: #000000"> })</span>
164
+ <span style="color: #000000"> });</span>
159
165
  <span style="color: #000000">} </span><span style="color: #AF00DB">catch</span><span style="color: #000000"> (</span><span style="color: #001080">err</span><span style="color: #000000">: </span><span style="color: #267F99">Error</span><span style="color: #000000">) {</span>
160
- <span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">err</span><span style="color: #000000">.</span><span style="color: #001080">errorCode</span><span style="color: #000000"> == </span><span style="color: #A31515">&quot;ERR_NGROK_1410&quot;</span><span style="color: #000000">) {</span>
161
- <span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;not a valid ip policy action&#039;</span><span style="color: #000000">)</span>
166
+ <span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">err</span><span style="color: #000000">.</span><span style="color: #001080">errorCode</span><span style="color: #000000"> == </span><span style="color: #A31515">&#039;ERR_NGROK_1410&#039;</span><span style="color: #000000">) {</span>
167
+ <span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;not a valid ip policy action&#039;</span><span style="color: #000000">);</span>
162
168
  <span style="color: #000000"> } </span><span style="color: #AF00DB">else</span><span style="color: #000000"> {</span>
163
- <span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;some other error&#039;</span><span style="color: #000000">, </span><span style="color: #001080">err</span><span style="color: #000000">)</span>
169
+ <span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;some other error&#039;</span><span style="color: #000000">, </span><span style="color: #001080">err</span><span style="color: #000000">);</span>
164
170
  <span style="color: #000000"> }</span>
165
171
  <span style="color: #000000">}</span>
166
172
  </code></pre>
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">api<wbr>Token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L16">client.ts:16</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L16">client.ts:16</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  </section>
@@ -108,7 +108,7 @@
108
108
  <div class="tsd-signature tsd-kind-icon">base<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
109
109
  <aside class="tsd-sources">
110
110
  <ul>
111
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L17">client.ts:17</a></li>
111
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/client.ts#L17">client.ts:17</a></li>
112
112
  </ul>
113
113
  </aside>
114
114
  </section>
@@ -102,7 +102,7 @@
102
102
  <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
103
103
  <aside class="tsd-sources">
104
104
  <ul>
105
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L128">datatypes.ts:128</a></li>
105
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L128">datatypes.ts:128</a></li>
106
106
  </ul>
107
107
  </aside>
108
108
  <div class="tsd-comment tsd-typography">
@@ -117,7 +117,7 @@
117
117
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
118
118
  <aside class="tsd-sources">
119
119
  <ul>
120
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L124">datatypes.ts:124</a></li>
120
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L124">datatypes.ts:124</a></li>
121
121
  </ul>
122
122
  </aside>
123
123
  <div class="tsd-comment tsd-typography">
@@ -132,7 +132,7 @@
132
132
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
133
133
  <aside class="tsd-sources">
134
134
  <ul>
135
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L120">datatypes.ts:120</a></li>
135
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L120">datatypes.ts:120</a></li>
136
136
  </ul>
137
137
  </aside>
138
138
  <div class="tsd-comment tsd-typography">
@@ -147,7 +147,7 @@
147
147
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
148
148
  <aside class="tsd-sources">
149
149
  <ul>
150
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L126">datatypes.ts:126</a></li>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L126">datatypes.ts:126</a></li>
151
151
  </ul>
152
152
  </aside>
153
153
  <div class="tsd-comment tsd-typography">
@@ -162,7 +162,7 @@
162
162
  <div class="tsd-signature tsd-kind-icon">token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
163
163
  <aside class="tsd-sources">
164
164
  <ul>
165
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L130">datatypes.ts:130</a></li>
165
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L130">datatypes.ts:130</a></li>
166
166
  </ul>
167
167
  </aside>
168
168
  <div class="tsd-comment tsd-typography">
@@ -177,7 +177,7 @@
177
177
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
178
178
  <aside class="tsd-sources">
179
179
  <ul>
180
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L122">datatypes.ts:122</a></li>
180
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L122">datatypes.ts:122</a></li>
181
181
  </ul>
182
182
  </aside>
183
183
  <div class="tsd-comment tsd-typography">
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L105">datatypes.ts:105</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L105">datatypes.ts:105</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  <div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
113
113
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
114
114
  <aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L107">datatypes.ts:107</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L107">datatypes.ts:107</a></li>
117
117
  </ul>
118
118
  </aside>
119
119
  <div class="tsd-comment tsd-typography">
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">keys<span class="tsd-signature-symbol">:</span> <a href="datatypes.APIKey.html" class="tsd-signature-type" data-tsd-kind="Interface">APIKey</a><span class="tsd-signature-symbol">[]</span></div>
100
100
  <aside class="tsd-sources">
101
101
  <ul>
102
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L135">datatypes.ts:135</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L135">datatypes.ts:135</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  <div class="tsd-comment tsd-typography">
@@ -114,7 +114,7 @@
114
114
  <div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
115
115
  <aside class="tsd-sources">
116
116
  <ul>
117
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L139">datatypes.ts:139</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L139">datatypes.ts:139</a></li>
118
118
  </ul>
119
119
  </aside>
120
120
  <div class="tsd-comment tsd-typography">
@@ -129,7 +129,7 @@
129
129
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130
130
  <aside class="tsd-sources">
131
131
  <ul>
132
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L137">datatypes.ts:137</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L137">datatypes.ts:137</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <div class="tsd-comment tsd-typography">
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
100
  <aside class="tsd-sources">
101
101
  <ul>
102
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L113">datatypes.ts:113</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L113">datatypes.ts:113</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  <div class="tsd-comment tsd-typography">
@@ -114,7 +114,7 @@
114
114
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
115
115
  <aside class="tsd-sources">
116
116
  <ul>
117
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L111">datatypes.ts:111</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L111">datatypes.ts:111</a></li>
118
118
  </ul>
119
119
  </aside>
120
120
  </section>
@@ -124,7 +124,7 @@
124
124
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
125
125
  <aside class="tsd-sources">
126
126
  <ul>
127
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L115">datatypes.ts:115</a></li>
127
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L115">datatypes.ts:115</a></li>
128
128
  </ul>
129
129
  </aside>
130
130
  <div class="tsd-comment tsd-typography">
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">creds<span class="tsd-signature-symbol">:</span> <a href="datatypes.AWSCredentials.html" class="tsd-signature-type" data-tsd-kind="Interface">AWSCredentials</a></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1190">datatypes.ts:1190</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1190">datatypes.ts:1190</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  <div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
113
113
  <div class="tsd-signature tsd-kind-icon">role<span class="tsd-signature-symbol">:</span> <a href="datatypes.AWSRole.html" class="tsd-signature-type" data-tsd-kind="Interface">AWSRole</a></div>
114
114
  <aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1188">datatypes.ts:1188</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1188">datatypes.ts:1188</a></li>
117
117
  </ul>
118
118
  </aside>
119
119
  <div class="tsd-comment tsd-typography">
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">aws<wbr>Access<wbr>Key<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1200">datatypes.ts:1200</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1200">datatypes.ts:1200</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  <div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
113
113
  <div class="tsd-signature tsd-kind-icon">aws<wbr>Secret<wbr>Access<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
114
114
  <aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1202">datatypes.ts:1202</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1202">datatypes.ts:1202</a></li>
117
117
  </ul>
118
118
  </aside>
119
119
  <div class="tsd-comment tsd-typography">
@@ -97,7 +97,7 @@
97
97
  <div class="tsd-signature tsd-kind-icon">role<wbr>Arn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
98
98
  <aside class="tsd-sources">
99
99
  <ul>
100
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1195">datatypes.ts:1195</a></li>
100
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1195">datatypes.ts:1195</a></li>
101
101
  </ul>
102
102
  </aside>
103
103
  <div class="tsd-comment tsd-typography">
@@ -103,7 +103,7 @@
103
103
  <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
104
104
  <aside class="tsd-sources">
105
105
  <ul>
106
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L33">datatypes.ts:33</a></li>
106
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L33">datatypes.ts:33</a></li>
107
107
  </ul>
108
108
  </aside>
109
109
  <div class="tsd-comment tsd-typography">
@@ -118,7 +118,7 @@
118
118
  <div class="tsd-signature tsd-kind-icon">hostnames<span class="tsd-signature-symbol">:</span> <a href="datatypes.AbuseReportHostname.html" class="tsd-signature-type" data-tsd-kind="Interface">AbuseReportHostname</a><span class="tsd-signature-symbol">[]</span></div>
119
119
  <aside class="tsd-sources">
120
120
  <ul>
121
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L41">datatypes.ts:41</a></li>
121
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L41">datatypes.ts:41</a></li>
122
122
  </ul>
123
123
  </aside>
124
124
  <div class="tsd-comment tsd-typography">
@@ -133,7 +133,7 @@
133
133
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
134
134
  <aside class="tsd-sources">
135
135
  <ul>
136
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L29">datatypes.ts:29</a></li>
136
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L29">datatypes.ts:29</a></li>
137
137
  </ul>
138
138
  </aside>
139
139
  <div class="tsd-comment tsd-typography">
@@ -148,7 +148,7 @@
148
148
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
149
149
  <aside class="tsd-sources">
150
150
  <ul>
151
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L37">datatypes.ts:37</a></li>
151
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L37">datatypes.ts:37</a></li>
152
152
  </ul>
153
153
  </aside>
154
154
  <div class="tsd-comment tsd-typography">
@@ -163,7 +163,7 @@
163
163
  <div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
164
164
  <aside class="tsd-sources">
165
165
  <ul>
166
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L39">datatypes.ts:39</a></li>
166
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L39">datatypes.ts:39</a></li>
167
167
  </ul>
168
168
  </aside>
169
169
  <div class="tsd-comment tsd-typography">
@@ -178,7 +178,7 @@
178
178
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
179
179
  <aside class="tsd-sources">
180
180
  <ul>
181
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L31">datatypes.ts:31</a></li>
181
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L31">datatypes.ts:31</a></li>
182
182
  </ul>
183
183
  </aside>
184
184
  <div class="tsd-comment tsd-typography">
@@ -193,7 +193,7 @@
193
193
  <div class="tsd-signature tsd-kind-icon">urls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
194
194
  <aside class="tsd-sources">
195
195
  <ul>
196
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L35">datatypes.ts:35</a></li>
196
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L35">datatypes.ts:35</a></li>
197
197
  </ul>
198
198
  </aside>
199
199
  <div class="tsd-comment tsd-typography">
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L55">datatypes.ts:55</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L55">datatypes.ts:55</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  <div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
113
113
  <div class="tsd-signature tsd-kind-icon">urls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
114
114
  <aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L53">datatypes.ts:53</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L53">datatypes.ts:53</a></li>
117
117
  </ul>
118
118
  </aside>
119
119
  <div class="tsd-comment tsd-typography">
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">hostname<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L46">datatypes.ts:46</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L46">datatypes.ts:46</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  <div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
113
113
  <div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
114
114
  <aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L48">datatypes.ts:48</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L48">datatypes.ts:48</a></li>
117
117
  </ul>
118
118
  </aside>
119
119
  <div class="tsd-comment tsd-typography">