@ngrok/ngrok-api 0.8.0 → 0.10.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 (271) hide show
  1. package/.eslintignore +2 -0
  2. package/.eslintrc.js +2 -0
  3. package/.prettierrc.js +2 -0
  4. package/CHANGELOG.md +12 -3
  5. package/CODE_OF_CONDUCT.md +45 -0
  6. package/README.md +30 -19
  7. package/docs/assets/js/search.js +1 -1
  8. package/docs/classes/client.Ngrok.html +54 -26
  9. package/docs/classes/services.APIKeys.html +20 -11
  10. package/docs/classes/services.AbuseReports.html +5 -5
  11. package/docs/classes/services.AgentIngresses.html +20 -11
  12. package/docs/classes/services.ApplicationSessions.html +288 -0
  13. package/docs/classes/services.ApplicationUsers.html +288 -0
  14. package/docs/classes/services.CertificateAuthorities.html +20 -11
  15. package/docs/classes/services.Credentials.html +21 -12
  16. package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
  17. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
  18. package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
  19. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
  20. package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
  21. package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
  22. package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
  23. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
  24. package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
  25. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
  26. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
  27. package/docs/classes/services.EdgesHTTPS.html +20 -11
  28. package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
  29. package/docs/classes/services.EdgesTCP.html +20 -11
  30. package/docs/classes/services.EdgesTLS.html +20 -11
  31. package/docs/classes/services.Endpoints.html +15 -6
  32. package/docs/classes/services.EventDestinations.html +21 -12
  33. package/docs/classes/services.EventSources.html +6 -6
  34. package/docs/classes/services.EventSubscriptions.html +20 -11
  35. package/docs/classes/services.FailoverBackends.html +21 -12
  36. package/docs/classes/services.HTTPResponseBackends.html +20 -11
  37. package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +8 -8
  38. package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +8 -8
  39. package/docs/classes/services.IPPolicies.html +20 -11
  40. package/docs/classes/services.IPPolicyRules.html +20 -11
  41. package/docs/classes/services.IPRestrictions.html +20 -11
  42. package/docs/classes/services.ReservedAddrs.html +20 -11
  43. package/docs/classes/services.ReservedDomains.html +26 -17
  44. package/docs/classes/services.SSHCertificateAuthorities.html +20 -11
  45. package/docs/classes/services.SSHCredentials.html +20 -11
  46. package/docs/classes/services.SSHHostCertificates.html +20 -11
  47. package/docs/classes/services.SSHUserCertificates.html +20 -11
  48. package/docs/classes/services.TCPEdgeBackendModule.html +8 -8
  49. package/docs/classes/services.TCPEdgeIPRestrictionModule.html +8 -8
  50. package/docs/classes/services.TLSCertificates.html +20 -11
  51. package/docs/classes/services.TLSEdgeBackendModule.html +8 -8
  52. package/docs/classes/services.TLSEdgeIPRestrictionModule.html +8 -8
  53. package/docs/classes/services.TLSEdgeMutualTLSModule.html +8 -8
  54. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +8 -8
  55. package/docs/classes/services.TunnelGroupBackends.html +21 -12
  56. package/docs/classes/services.TunnelSessions.html +22 -13
  57. package/docs/classes/services.Tunnels.html +15 -6
  58. package/docs/classes/services.WeightedBackends.html +21 -12
  59. package/docs/index.html +30 -19
  60. package/docs/interfaces/client.NgrokConfig.html +2 -2
  61. package/docs/interfaces/datatypes.APIKey.html +28 -9
  62. package/docs/interfaces/datatypes.APIKeyCreate.html +23 -4
  63. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  64. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  65. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  66. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  67. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  68. package/docs/interfaces/datatypes.AbuseReport.html +9 -9
  69. package/docs/interfaces/datatypes.AbuseReportCreate.html +3 -3
  70. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  71. package/docs/interfaces/datatypes.AgentIngress.html +49 -11
  72. package/docs/interfaces/datatypes.AgentIngressCertJob.html +224 -0
  73. package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +186 -0
  74. package/docs/interfaces/datatypes.AgentIngressCertStatus.html +186 -0
  75. package/docs/interfaces/datatypes.AgentIngressCreate.html +24 -5
  76. package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
  77. package/docs/interfaces/datatypes.AgentIngressUpdate.html +22 -3
  78. package/docs/interfaces/datatypes.ApplicationSession.html +357 -0
  79. package/docs/interfaces/datatypes.ApplicationSessionList.html +205 -0
  80. package/docs/interfaces/datatypes.ApplicationUser.html +338 -0
  81. package/docs/interfaces/datatypes.ApplicationUserList.html +205 -0
  82. package/docs/interfaces/datatypes.BrowserSession.html +205 -0
  83. package/docs/interfaces/datatypes.CertificateAuthority.html +16 -16
  84. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +5 -5
  85. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  86. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  87. package/docs/interfaces/datatypes.Credential.html +31 -12
  88. package/docs/interfaces/datatypes.CredentialCreate.html +25 -6
  89. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  90. package/docs/interfaces/datatypes.CredentialUpdate.html +5 -5
  91. package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
  92. package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
  93. package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
  94. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
  95. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
  96. package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
  97. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
  98. package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
  99. package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
  100. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
  101. package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
  102. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
  103. package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
  104. package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
  105. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
  106. package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
  107. package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
  108. package/docs/interfaces/datatypes.Endpoint.html +19 -19
  109. package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
  110. package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
  111. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  112. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  113. package/docs/interfaces/datatypes.EndpointIPPolicy.html +7 -2
  114. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  115. package/docs/interfaces/datatypes.EndpointList.html +3 -3
  116. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  117. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +3 -3
  118. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  119. package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +218 -0
  120. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  121. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +12 -12
  122. package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +218 -0
  123. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  124. package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +218 -0
  125. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  126. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +80 -4
  127. package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +218 -0
  128. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  129. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  130. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  131. package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
  132. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
  133. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  134. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
  135. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
  136. package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
  137. package/docs/interfaces/datatypes.Error.html +4 -4
  138. package/docs/interfaces/datatypes.EventDestination.html +10 -10
  139. package/docs/interfaces/datatypes.EventDestinationCreate.html +6 -6
  140. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  141. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  142. package/docs/interfaces/datatypes.EventSource.html +2 -2
  143. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  144. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  145. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  146. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  147. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  148. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  149. package/docs/interfaces/datatypes.EventSubscription.html +10 -10
  150. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +6 -6
  151. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  152. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
  153. package/docs/interfaces/datatypes.EventTarget.html +22 -3
  154. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  155. package/docs/interfaces/datatypes.EventTargetDatadog.html +224 -0
  156. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  157. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  158. package/docs/interfaces/datatypes.FailoverBackend.html +9 -9
  159. package/docs/interfaces/datatypes.FailoverBackendCreate.html +5 -5
  160. package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
  161. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
  162. package/docs/interfaces/datatypes.HTTPResponseBackend.html +11 -11
  163. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +7 -7
  164. package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
  165. package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
  166. package/docs/interfaces/datatypes.HTTPSEdge.html +12 -12
  167. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +7 -7
  168. package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
  169. package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +22 -22
  170. package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +18 -18
  171. package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +19 -19
  172. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
  173. package/docs/interfaces/datatypes.IPPolicy.html +8 -8
  174. package/docs/interfaces/datatypes.IPPolicyCreate.html +4 -4
  175. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  176. package/docs/interfaces/datatypes.IPPolicyRule.html +11 -11
  177. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +7 -7
  178. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  179. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  180. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  181. package/docs/interfaces/datatypes.IPRestriction.html +11 -11
  182. package/docs/interfaces/datatypes.IPRestrictionCreate.html +7 -7
  183. package/docs/interfaces/datatypes.IPRestrictionList.html +4 -4
  184. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  185. package/docs/interfaces/datatypes.IdentityProvider.html +186 -0
  186. package/docs/interfaces/datatypes.Item.html +1 -1
  187. package/docs/interfaces/datatypes.Location.html +224 -0
  188. package/docs/interfaces/datatypes.Paging.html +2 -2
  189. package/docs/interfaces/datatypes.Ref.html +2 -2
  190. package/docs/interfaces/datatypes.ReservedAddr.html +10 -10
  191. package/docs/interfaces/datatypes.ReservedAddrCreate.html +5 -5
  192. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  193. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
  194. package/docs/interfaces/datatypes.ReservedDomain.html +15 -15
  195. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +6 -6
  196. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  197. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +3 -3
  198. package/docs/interfaces/datatypes.ReservedDomainCreate.html +18 -18
  199. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  200. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
  201. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +10 -10
  202. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +7 -7
  203. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  204. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  205. package/docs/interfaces/datatypes.SSHCredential.html +30 -11
  206. package/docs/interfaces/datatypes.SSHCredentialCreate.html +26 -7
  207. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  208. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +5 -5
  209. package/docs/interfaces/datatypes.SSHHostCertificate.html +17 -17
  210. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +11 -11
  211. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  212. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  213. package/docs/interfaces/datatypes.SSHUserCertificate.html +20 -20
  214. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +14 -14
  215. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  216. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  217. package/docs/interfaces/datatypes.TCPEdge.html +11 -11
  218. package/docs/interfaces/datatypes.TCPEdgeCreate.html +7 -7
  219. package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
  220. package/docs/interfaces/datatypes.TCPEdgeUpdate.html +6 -6
  221. package/docs/interfaces/datatypes.TLSCertificate.html +28 -28
  222. package/docs/interfaces/datatypes.TLSCertificateCreate.html +8 -8
  223. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  224. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  225. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  226. package/docs/interfaces/datatypes.TLSEdge.html +13 -13
  227. package/docs/interfaces/datatypes.TLSEdgeCreate.html +9 -9
  228. package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
  229. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +8 -8
  230. package/docs/interfaces/datatypes.Tunnel.html +17 -17
  231. package/docs/interfaces/datatypes.TunnelGroupBackend.html +10 -10
  232. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +5 -5
  233. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
  234. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
  235. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  236. package/docs/interfaces/datatypes.TunnelSession.html +12 -12
  237. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  238. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  239. package/docs/interfaces/datatypes.UserAgent.html +262 -0
  240. package/docs/interfaces/datatypes.WeightedBackend.html +10 -10
  241. package/docs/interfaces/datatypes.WeightedBackendCreate.html +6 -6
  242. package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
  243. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +5 -5
  244. package/docs/modules/datatypes.html +64 -0
  245. package/docs/modules/services.html +8 -0
  246. package/jest.config.js +2 -0
  247. package/lib/client.d.ts +9 -7
  248. package/lib/client.d.ts.map +1 -1
  249. package/lib/client.js +89 -119
  250. package/lib/client.js.map +1 -1
  251. package/lib/datatypes.d.ts +400 -209
  252. package/lib/datatypes.d.ts.map +1 -1
  253. package/lib/datatypes.js +4 -3
  254. package/lib/datatypes.js.map +1 -1
  255. package/lib/index.d.ts.map +1 -1
  256. package/lib/index.js +16 -28
  257. package/lib/index.js.map +1 -1
  258. package/lib/services.d.ts +167 -129
  259. package/lib/services.d.ts.map +1 -1
  260. package/lib/services.js +3294 -3356
  261. package/lib/services.js.map +1 -1
  262. package/lib/util.d.ts.map +1 -1
  263. package/lib/util.js +35 -34
  264. package/lib/util.js.map +1 -1
  265. package/package.json +3 -3
  266. package/src/client.ts +17 -33
  267. package/src/datatypes.ts +421 -212
  268. package/src/index.ts +2 -0
  269. package/src/services.ts +771 -522
  270. package/src/util.ts +2 -0
  271. package/test/apikey.test.js +62 -63
@@ -101,7 +101,7 @@
101
101
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
102
102
  <aside class="tsd-sources">
103
103
  <ul>
104
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1222">datatypes.ts:1222</a></li>
104
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1463">datatypes.ts:1463</a></li>
105
105
  </ul>
106
106
  </aside>
107
107
  <div class="tsd-comment tsd-typography">
@@ -116,7 +116,7 @@
116
116
  <div class="tsd-signature tsd-kind-icon">destination<wbr>Ids<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
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/datatypes.ts#L1226">datatypes.ts:1226</a></li>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1467">datatypes.ts:1467</a></li>
120
120
  </ul>
121
121
  </aside>
122
122
  <div class="tsd-comment tsd-typography">
@@ -131,7 +131,7 @@
131
131
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
132
132
  <aside class="tsd-sources">
133
133
  <ul>
134
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1218">datatypes.ts:1218</a></li>
134
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1459">datatypes.ts:1459</a></li>
135
135
  </ul>
136
136
  </aside>
137
137
  <div class="tsd-comment tsd-typography">
@@ -146,7 +146,7 @@
146
146
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
147
147
  <aside class="tsd-sources">
148
148
  <ul>
149
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1220">datatypes.ts:1220</a></li>
149
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1461">datatypes.ts:1461</a></li>
150
150
  </ul>
151
151
  </aside>
152
152
  <div class="tsd-comment tsd-typography">
@@ -161,7 +161,7 @@
161
161
  <div class="tsd-signature tsd-kind-icon">sources<span class="tsd-signature-symbol">:</span> <a href="datatypes.EventSourceReplace.html" class="tsd-signature-type" data-tsd-kind="Interface">EventSourceReplace</a><span class="tsd-signature-symbol">[]</span></div>
162
162
  <aside class="tsd-sources">
163
163
  <ul>
164
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1224">datatypes.ts:1224</a></li>
164
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1465">datatypes.ts:1465</a></li>
165
165
  </ul>
166
166
  </aside>
167
167
  <div class="tsd-comment tsd-typography">
@@ -84,6 +84,7 @@
84
84
  <h3>Properties</h3>
85
85
  <ul class="tsd-index-list">
86
86
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventTarget.html#cloudwatchLogs" class="tsd-kind-icon">cloudwatch<wbr>Logs</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventTarget.html#datadog" class="tsd-kind-icon">datadog</a></li>
87
88
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventTarget.html#firehose" class="tsd-kind-icon">firehose</a></li>
88
89
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventTarget.html#kinesis" class="tsd-kind-icon">kinesis</a></li>
89
90
  </ul>
@@ -99,7 +100,7 @@
99
100
  <div class="tsd-signature tsd-kind-icon">cloudwatch<wbr>Logs<span class="tsd-signature-symbol">:</span> <a href="datatypes.EventTargetCloudwatchLogs.html" class="tsd-signature-type" data-tsd-kind="Interface">EventTargetCloudwatchLogs</a></div>
100
101
  <aside class="tsd-sources">
101
102
  <ul>
102
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1162">datatypes.ts:1162</a></li>
103
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1390">datatypes.ts:1390</a></li>
103
104
  </ul>
104
105
  </aside>
105
106
  <div class="tsd-comment tsd-typography">
@@ -108,13 +109,28 @@
108
109
  </div>
109
110
  </div>
110
111
  </section>
112
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
113
+ <a name="datadog" class="tsd-anchor"></a>
114
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> datadog</h3>
115
+ <div class="tsd-signature tsd-kind-icon">datadog<span class="tsd-signature-symbol">:</span> <a href="datatypes.EventTargetDatadog.html" class="tsd-signature-type" data-tsd-kind="Interface">EventTargetDatadog</a></div>
116
+ <aside class="tsd-sources">
117
+ <ul>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1392">datatypes.ts:1392</a></li>
119
+ </ul>
120
+ </aside>
121
+ <div class="tsd-comment tsd-typography">
122
+ <div class="lead">
123
+ <p>Configuration used to send events to Datadog.</p>
124
+ </div>
125
+ </div>
126
+ </section>
111
127
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
112
128
  <a name="firehose" class="tsd-anchor"></a>
113
129
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> firehose</h3>
114
130
  <div class="tsd-signature tsd-kind-icon">firehose<span class="tsd-signature-symbol">:</span> <a href="datatypes.EventTargetFirehose.html" class="tsd-signature-type" data-tsd-kind="Interface">EventTargetFirehose</a></div>
115
131
  <aside class="tsd-sources">
116
132
  <ul>
117
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1158">datatypes.ts:1158</a></li>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1386">datatypes.ts:1386</a></li>
118
134
  </ul>
119
135
  </aside>
120
136
  <div class="tsd-comment tsd-typography">
@@ -129,7 +145,7 @@
129
145
  <div class="tsd-signature tsd-kind-icon">kinesis<span class="tsd-signature-symbol">:</span> <a href="datatypes.EventTargetKinesis.html" class="tsd-signature-type" data-tsd-kind="Interface">EventTargetKinesis</a></div>
130
146
  <aside class="tsd-sources">
131
147
  <ul>
132
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1160">datatypes.ts:1160</a></li>
148
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1388">datatypes.ts:1388</a></li>
133
149
  </ul>
134
150
  </aside>
135
151
  <div class="tsd-comment tsd-typography">
@@ -167,6 +183,9 @@
167
183
  <li class=" tsd-kind-property tsd-parent-kind-interface">
168
184
  <a href="datatypes.EventTarget.html#cloudwatchLogs" class="tsd-kind-icon">cloudwatch<wbr>Logs</a>
169
185
  </li>
186
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
187
+ <a href="datatypes.EventTarget.html#datadog" class="tsd-kind-icon">datadog</a>
188
+ </li>
170
189
  <li class=" tsd-kind-property tsd-parent-kind-interface">
171
190
  <a href="datatypes.EventTarget.html#firehose" class="tsd-kind-icon">firehose</a>
172
191
  </li>
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">auth<span class="tsd-signature-symbol">:</span> <a href="datatypes.AWSAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">AWSAuth</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#L1181">datatypes.ts:1181</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1411">datatypes.ts:1411</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">log<wbr>Group<wbr>Arn<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#L1183">datatypes.ts:1183</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1413">datatypes.ts:1413</a></li>
117
117
  </ul>
118
118
  </aside>
119
119
  <div class="tsd-comment tsd-typography">
@@ -0,0 +1,224 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>EventTargetDatadog | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.EventTargetDatadog.html">EventTargetDatadog</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface EventTargetDatadog</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">EventTargetDatadog</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventTargetDatadog.html#apiKey" class="tsd-kind-icon">api<wbr>Key</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventTargetDatadog.html#ddsite" class="tsd-kind-icon">ddsite</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventTargetDatadog.html#ddtags" class="tsd-kind-icon">ddtags</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventTargetDatadog.html#service" class="tsd-kind-icon">service</a></li>
90
+ </ul>
91
+ </section>
92
+ </div>
93
+ </section>
94
+ </section>
95
+ <section class="tsd-panel-group tsd-member-group ">
96
+ <h2>Properties</h2>
97
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
98
+ <a name="apiKey" class="tsd-anchor"></a>
99
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> api<wbr>Key</h3>
100
+ <div class="tsd-signature tsd-kind-icon">api<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
101
+ <aside class="tsd-sources">
102
+ <ul>
103
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1418">datatypes.ts:1418</a></li>
104
+ </ul>
105
+ </aside>
106
+ <div class="tsd-comment tsd-typography">
107
+ <div class="lead">
108
+ <p>Datadog API key to use.</p>
109
+ </div>
110
+ </div>
111
+ </section>
112
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
113
+ <a name="ddsite" class="tsd-anchor"></a>
114
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ddsite</h3>
115
+ <div class="tsd-signature tsd-kind-icon">ddsite<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
116
+ <aside class="tsd-sources">
117
+ <ul>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1424">datatypes.ts:1424</a></li>
119
+ </ul>
120
+ </aside>
121
+ <div class="tsd-comment tsd-typography">
122
+ <div class="lead">
123
+ <p>Datadog site to send event to.</p>
124
+ </div>
125
+ </div>
126
+ </section>
127
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
128
+ <a name="ddtags" class="tsd-anchor"></a>
129
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ddtags</h3>
130
+ <div class="tsd-signature tsd-kind-icon">ddtags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
131
+ <aside class="tsd-sources">
132
+ <ul>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1420">datatypes.ts:1420</a></li>
134
+ </ul>
135
+ </aside>
136
+ <div class="tsd-comment tsd-typography">
137
+ <div class="lead">
138
+ <p>Tags to send with the event.</p>
139
+ </div>
140
+ </div>
141
+ </section>
142
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
143
+ <a name="service" class="tsd-anchor"></a>
144
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> service</h3>
145
+ <div class="tsd-signature tsd-kind-icon">service<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
146
+ <aside class="tsd-sources">
147
+ <ul>
148
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1422">datatypes.ts:1422</a></li>
149
+ </ul>
150
+ </aside>
151
+ <div class="tsd-comment tsd-typography">
152
+ <div class="lead">
153
+ <p>Service name to send with the event.</p>
154
+ </div>
155
+ </div>
156
+ </section>
157
+ </section>
158
+ </div>
159
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
160
+ <nav class="tsd-navigation primary">
161
+ <ul>
162
+ <li class=" ">
163
+ <a href="../modules.html">Modules</a>
164
+ </li>
165
+ <li class=" tsd-kind-module">
166
+ <a href="../modules/client.html">client</a>
167
+ </li>
168
+ <li class="current tsd-kind-module">
169
+ <a href="../modules/datatypes.html">datatypes</a>
170
+ </li>
171
+ <li class=" tsd-kind-module">
172
+ <a href="../modules/services.html">services</a>
173
+ </li>
174
+ </ul>
175
+ </nav>
176
+ <nav class="tsd-navigation secondary menu-sticky">
177
+ <ul class="before-current">
178
+ </ul>
179
+ <ul class="current">
180
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
181
+ <a href="datatypes.EventTargetDatadog.html" class="tsd-kind-icon">Event<wbr>Target<wbr>Datadog</a>
182
+ <ul>
183
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
184
+ <a href="datatypes.EventTargetDatadog.html#apiKey" class="tsd-kind-icon">api<wbr>Key</a>
185
+ </li>
186
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
187
+ <a href="datatypes.EventTargetDatadog.html#ddsite" class="tsd-kind-icon">ddsite</a>
188
+ </li>
189
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
190
+ <a href="datatypes.EventTargetDatadog.html#ddtags" class="tsd-kind-icon">ddtags</a>
191
+ </li>
192
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
193
+ <a href="datatypes.EventTargetDatadog.html#service" class="tsd-kind-icon">service</a>
194
+ </li>
195
+ </ul>
196
+ </li>
197
+ </ul>
198
+ <ul class="after-current">
199
+ </ul>
200
+ </nav>
201
+ </div>
202
+ </div>
203
+ </div>
204
+ <footer class="with-border-bottom">
205
+ <div class="container">
206
+ <h2>Legend</h2>
207
+ <div class="tsd-legend-group">
208
+ <ul class="tsd-legend">
209
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
210
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
211
+ </ul>
212
+ <ul class="tsd-legend">
213
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
214
+ </ul>
215
+ </div>
216
+ </div>
217
+ </footer>
218
+ <div class="container tsd-generator">
219
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
220
+ </div>
221
+ <div class="overlay"></div>
222
+ <script src="../assets/js/main.js"></script>
223
+ </body>
224
+ </html>
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">auth<span class="tsd-signature-symbol">:</span> <a href="datatypes.AWSAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">AWSAuth</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#L1167">datatypes.ts:1167</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1397">datatypes.ts:1397</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">delivery<wbr>Stream<wbr>Arn<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#L1169">datatypes.ts:1169</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1399">datatypes.ts:1399</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">auth<span class="tsd-signature-symbol">:</span> <a href="datatypes.AWSAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">AWSAuth</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#L1174">datatypes.ts:1174</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1404">datatypes.ts:1404</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">stream<wbr>Arn<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#L1176">datatypes.ts:1176</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1406">datatypes.ts:1406</a></li>
117
117
  </ul>
118
118
  </aside>
119
119
  <div class="tsd-comment tsd-typography">
@@ -102,7 +102,7 @@
102
102
  <div class="tsd-signature tsd-kind-icon">backends<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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#L154">datatypes.ts:154</a></li>
105
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L337">datatypes.ts:337</a></li>
106
106
  </ul>
107
107
  </aside>
108
108
  <div class="tsd-comment tsd-typography">
@@ -114,10 +114,10 @@
114
114
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
115
115
  <a name="createdAt" class="tsd-anchor"></a>
116
116
  <h3>created<wbr>At</h3>
117
- <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
117
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</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#L148">datatypes.ts:148</a></li>
120
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L331">datatypes.ts:331</a></li>
121
121
  </ul>
122
122
  </aside>
123
123
  <div class="tsd-comment tsd-typography">
@@ -128,11 +128,11 @@
128
128
  </section>
129
129
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
130
130
  <a name="description" class="tsd-anchor"></a>
131
- <h3>description</h3>
131
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
132
132
  <div class="tsd-signature tsd-kind-icon">description<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#L150">datatypes.ts:150</a></li>
135
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L333">datatypes.ts:333</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">id<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#L144">datatypes.ts:144</a></li>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L327">datatypes.ts:327</a></li>
151
151
  </ul>
152
152
  </aside>
153
153
  <div class="tsd-comment tsd-typography">
@@ -158,11 +158,11 @@
158
158
  </section>
159
159
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
160
160
  <a name="metadata" class="tsd-anchor"></a>
161
- <h3>metadata</h3>
161
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
162
162
  <div class="tsd-signature tsd-kind-icon">metadata<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#L152">datatypes.ts:152</a></li>
165
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L335">datatypes.ts:335</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#L146">datatypes.ts:146</a></li>
180
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L329">datatypes.ts:329</a></li>
181
181
  </ul>
182
182
  </aside>
183
183
  <div class="tsd-comment tsd-typography">
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">backends<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><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#L163">datatypes.ts:163</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L346">datatypes.ts:346</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  <div class="tsd-comment tsd-typography">
@@ -110,11 +110,11 @@
110
110
  </section>
111
111
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
112
112
  <a name="description" class="tsd-anchor"></a>
113
- <h3>description</h3>
113
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
114
114
  <div class="tsd-signature tsd-kind-icon">description<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#L159">datatypes.ts:159</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L342">datatypes.ts:342</a></li>
118
118
  </ul>
119
119
  </aside>
120
120
  <div class="tsd-comment tsd-typography">
@@ -125,11 +125,11 @@
125
125
  </section>
126
126
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
127
127
  <a name="metadata" class="tsd-anchor"></a>
128
- <h3>metadata</h3>
128
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
129
129
  <div class="tsd-signature tsd-kind-icon">metadata<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#L161">datatypes.ts:161</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L344">datatypes.ts:344</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">backends<span class="tsd-signature-symbol">:</span> <a href="datatypes.FailoverBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">FailoverBackend</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#L178">datatypes.ts:178</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L361">datatypes.ts:361</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#L182">datatypes.ts:182</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L365">datatypes.ts:365</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#L180">datatypes.ts:180</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L363">datatypes.ts:363</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <div class="tsd-comment tsd-typography">
@@ -100,7 +100,7 @@
100
100
  <div class="tsd-signature tsd-kind-icon">backends<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
101
101
  <aside class="tsd-sources">
102
102
  <ul>
103
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L173">datatypes.ts:173</a></li>
103
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L356">datatypes.ts:356</a></li>
104
104
  </ul>
105
105
  </aside>
106
106
  <div class="tsd-comment tsd-typography">
@@ -115,7 +115,7 @@
115
115
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
116
116
  <aside class="tsd-sources">
117
117
  <ul>
118
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L169">datatypes.ts:169</a></li>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L352">datatypes.ts:352</a></li>
119
119
  </ul>
120
120
  </aside>
121
121
  <div class="tsd-comment tsd-typography">
@@ -130,7 +130,7 @@
130
130
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
131
131
  <aside class="tsd-sources">
132
132
  <ul>
133
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L167">datatypes.ts:167</a></li>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L350">datatypes.ts:350</a></li>
134
134
  </ul>
135
135
  </aside>
136
136
  </section>
@@ -140,7 +140,7 @@
140
140
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
141
141
  <aside class="tsd-sources">
142
142
  <ul>
143
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L171">datatypes.ts:171</a></li>
143
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L354">datatypes.ts:354</a></li>
144
144
  </ul>
145
145
  </aside>
146
146
  <div class="tsd-comment tsd-typography">