@ngrok/ngrok-api 0.2.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (244) hide show
  1. package/README.md +0 -28
  2. package/docs/CNAME +1 -0
  3. package/docs/assets/js/search.js +1 -1
  4. package/docs/classes/client.Ngrok.html +204 -119
  5. package/docs/classes/services.APIKeys.html +6 -105
  6. package/docs/classes/services.AbuseReports.html +3 -102
  7. package/docs/classes/{services.IPWhitelist.html → services.AgentIngresses.html} +41 -148
  8. package/docs/classes/services.CertificateAuthorities.html +6 -105
  9. package/docs/classes/services.Credentials.html +6 -105
  10. package/docs/classes/services.EdgeRouteBackendModule.html +270 -0
  11. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +270 -0
  12. package/docs/classes/services.EdgeRouteCompressionModule.html +270 -0
  13. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +270 -0
  14. package/docs/classes/services.EdgeRouteOAuthModule.html +270 -0
  15. package/docs/classes/services.EdgeRouteOIDCModule.html +270 -0
  16. package/docs/classes/{services.EndpointResponseHeadersModule.html → services.EdgeRouteRequestHeadersModule.html} +28 -127
  17. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +270 -0
  18. package/docs/classes/services.EdgeRouteSAMLModule.html +270 -0
  19. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +270 -0
  20. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +270 -0
  21. package/docs/classes/services.EdgesHTTPS.html +343 -0
  22. package/docs/classes/services.EdgesHTTPSRoutes.html +317 -0
  23. package/docs/classes/services.EdgesTCP.html +343 -0
  24. package/docs/classes/services.EdgesTLS.html +343 -0
  25. package/docs/classes/services.Endpoints.html +256 -0
  26. package/docs/classes/services.EventDestinations.html +7 -106
  27. package/docs/classes/services.EventSources.html +6 -105
  28. package/docs/classes/services.EventSubscriptions.html +6 -105
  29. package/docs/classes/{services.EventStreams.html → services.FailoverBackends.html} +51 -140
  30. package/docs/classes/services.HTTPResponseBackends.html +318 -0
  31. package/docs/classes/{services.EndpointMutualTLSModule.html → services.HTTPSEdgeMutualTLSModule.html} +22 -121
  32. package/docs/classes/{services.EndpointTLSTerminationModule.html → services.HTTPSEdgeTLSTerminationModule.html} +22 -121
  33. package/docs/classes/services.IPPolicies.html +6 -105
  34. package/docs/classes/services.IPPolicyRules.html +6 -105
  35. package/docs/classes/services.IPRestrictions.html +7 -106
  36. package/docs/classes/services.ReservedAddrs.html +6 -137
  37. package/docs/classes/services.ReservedDomains.html +8 -171
  38. package/docs/classes/services.SSHCertificateAuthorities.html +6 -105
  39. package/docs/classes/services.SSHCredentials.html +6 -105
  40. package/docs/classes/services.SSHHostCertificates.html +6 -105
  41. package/docs/classes/services.SSHUserCertificates.html +6 -105
  42. package/docs/classes/{services.EndpointSAMLModule.html → services.TCPEdgeBackendModule.html} +25 -124
  43. package/docs/classes/{services.EndpointIPPolicyModule.html → services.TCPEdgeIPRestrictionModule.html} +22 -121
  44. package/docs/classes/services.TLSCertificates.html +6 -105
  45. package/docs/classes/{services.EndpointLoggingModule.html → services.TLSEdgeBackendModule.html} +25 -124
  46. package/docs/classes/{services.EndpointOIDCModule.html → services.TLSEdgeIPRestrictionModule.html} +25 -124
  47. package/docs/classes/{services.EndpointOAuthModule.html → services.TLSEdgeMutualTLSModule.html} +25 -124
  48. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +270 -0
  49. package/docs/classes/services.TunnelGroupBackends.html +351 -0
  50. package/docs/classes/services.TunnelSessions.html +6 -105
  51. package/docs/classes/services.Tunnels.html +34 -101
  52. package/docs/classes/services.WeightedBackends.html +353 -0
  53. package/docs/index.html +0 -27
  54. package/docs/interfaces/client.NgrokConfig.html +2 -2
  55. package/docs/interfaces/datatypes.APIKey.html +6 -6
  56. package/docs/interfaces/datatypes.APIKeyCreate.html +2 -2
  57. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  58. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  59. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  60. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  61. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  62. package/docs/interfaces/datatypes.AbuseReport.html +7 -7
  63. package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
  64. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  65. package/docs/interfaces/{datatypes.EventStream.html → datatypes.AgentIngress.html} +52 -71
  66. package/docs/interfaces/datatypes.AgentIngressCreate.html +205 -0
  67. package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
  68. package/docs/interfaces/{datatypes.IPWhitelistEntryUpdate.html → datatypes.AgentIngressUpdate.html} +16 -16
  69. package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
  70. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
  71. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  72. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  73. package/docs/interfaces/datatypes.Credential.html +7 -7
  74. package/docs/interfaces/datatypes.CredentialCreate.html +3 -3
  75. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  76. package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
  77. package/docs/interfaces/{datatypes.EndpointCircuitBreakerReplace.html → datatypes.EdgeBackendReplace.html} +12 -12
  78. package/docs/interfaces/{datatypes.EndpointIPPolicyReplace.html → datatypes.EdgeIPRestrictionReplace.html} +11 -11
  79. package/docs/interfaces/{datatypes.EndpointMutualTLSReplace.html → datatypes.EdgeMutualTLSReplace.html} +11 -11
  80. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +190 -0
  81. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +190 -0
  82. package/docs/interfaces/{datatypes.EndpointCompressionReplace.html → datatypes.EdgeRouteCompressionReplace.html} +25 -11
  83. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +190 -0
  84. package/docs/interfaces/{datatypes.ReservedDomainCertNSTarget.html → datatypes.EdgeRouteItem.html} +19 -19
  85. package/docs/interfaces/{datatypes.EndpointOAuthReplace.html → datatypes.EdgeRouteOAuthReplace.html} +25 -11
  86. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +190 -0
  87. package/docs/interfaces/{datatypes.EndpointRequestHeadersReplace.html → datatypes.EdgeRouteRequestHeadersReplace.html} +25 -11
  88. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +190 -0
  89. package/docs/interfaces/{datatypes.EndpointSAMLReplace.html → datatypes.EdgeRouteSAMLReplace.html} +25 -11
  90. package/docs/interfaces/{datatypes.EndpointWebhookValidationReplace.html → datatypes.EdgeRouteWebhookVerificationReplace.html} +25 -11
  91. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +190 -0
  92. package/docs/interfaces/{datatypes.EndpointResponseHeadersReplace.html → datatypes.EdgeTLSTerminationAtEdgeReplace.html} +12 -12
  93. package/docs/interfaces/{datatypes.EndpointTLSTerminationReplace.html → datatypes.EdgeTLSTerminationReplace.html} +11 -11
  94. package/docs/interfaces/datatypes.Endpoint.html +395 -0
  95. package/docs/interfaces/{datatypes.EndpointLogging.html → datatypes.EndpointBackend.html} +19 -19
  96. package/docs/interfaces/{datatypes.EndpointLoggingMutate.html → datatypes.EndpointBackendMutate.html} +19 -19
  97. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  98. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  99. package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
  100. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  101. package/docs/interfaces/{datatypes.EndpointConfigurationList.html → datatypes.EndpointList.html} +19 -19
  102. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  103. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  104. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  105. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  106. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
  107. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  108. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  109. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +4 -4
  110. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  111. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  112. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  113. package/docs/interfaces/datatypes.EndpointSAML.html +33 -14
  114. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +28 -9
  115. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  116. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +186 -0
  117. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
  118. package/docs/interfaces/{datatypes.EndpointOIDCReplace.html → datatypes.EndpointWebsocketTCPConverter.html} +16 -25
  119. package/docs/interfaces/datatypes.Error.html +4 -4
  120. package/docs/interfaces/datatypes.EventDestination.html +7 -7
  121. package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
  122. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  123. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  124. package/docs/interfaces/datatypes.EventSource.html +2 -2
  125. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  126. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  127. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  128. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  129. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  130. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  131. package/docs/interfaces/datatypes.EventSubscription.html +7 -7
  132. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +5 -5
  133. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  134. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +6 -6
  135. package/docs/interfaces/datatypes.EventTarget.html +3 -3
  136. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  137. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  138. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  139. package/docs/interfaces/{datatypes.IPWhitelistEntry.html → datatypes.FailoverBackend.html} +41 -41
  140. package/docs/interfaces/{datatypes.IPWhitelistEntryCreate.html → datatypes.FailoverBackendCreate.html} +23 -23
  141. package/docs/interfaces/datatypes.FailoverBackendList.html +205 -0
  142. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +219 -0
  143. package/docs/interfaces/datatypes.HTTPResponseBackend.html +295 -0
  144. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +243 -0
  145. package/docs/interfaces/datatypes.HTTPResponseBackendList.html +190 -0
  146. package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +257 -0
  147. package/docs/interfaces/datatypes.HTTPSEdge.html +314 -0
  148. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +238 -0
  149. package/docs/interfaces/datatypes.HTTPSEdgeList.html +205 -0
  150. package/docs/interfaces/{datatypes.EndpointConfigurationUpdate.html → datatypes.HTTPSEdgeRoute.html} +154 -78
  151. package/docs/interfaces/{datatypes.EndpointConfigurationCreate.html → datatypes.HTTPSEdgeRouteCreate.html} +108 -89
  152. package/docs/interfaces/{datatypes.EndpointConfiguration.html → datatypes.HTTPSEdgeRouteUpdate.html} +104 -123
  153. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +257 -0
  154. package/docs/interfaces/datatypes.IPPolicy.html +5 -24
  155. package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -21
  156. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  157. package/docs/interfaces/datatypes.IPPolicyRule.html +26 -7
  158. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +23 -4
  159. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  160. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  161. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  162. package/docs/interfaces/datatypes.IPRestriction.html +8 -8
  163. package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
  164. package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
  165. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  166. package/docs/interfaces/datatypes.Item.html +1 -1
  167. package/docs/interfaces/datatypes.Paging.html +2 -2
  168. package/docs/interfaces/datatypes.Ref.html +2 -2
  169. package/docs/interfaces/datatypes.ReservedAddr.html +7 -26
  170. package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -22
  171. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  172. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -22
  173. package/docs/interfaces/datatypes.ReservedDomain.html +30 -49
  174. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -23
  175. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  176. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
  177. package/docs/interfaces/datatypes.ReservedDomainCreate.html +6 -44
  178. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  179. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -43
  180. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
  181. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
  182. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  183. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  184. package/docs/interfaces/datatypes.SSHCredential.html +7 -7
  185. package/docs/interfaces/datatypes.SSHCredentialCreate.html +4 -4
  186. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  187. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
  188. package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
  189. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
  190. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  191. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  192. package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
  193. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
  194. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  195. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  196. package/docs/interfaces/datatypes.TCPEdge.html +295 -0
  197. package/docs/interfaces/datatypes.TCPEdgeCreate.html +238 -0
  198. package/docs/interfaces/{datatypes.IPWhitelistEntryList.html → datatypes.TCPEdgeList.html} +22 -22
  199. package/docs/interfaces/{datatypes.EventStreamUpdate.html → datatypes.TCPEdgeUpdate.html} +43 -48
  200. package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
  201. package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
  202. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  203. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  204. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  205. package/docs/interfaces/datatypes.TLSEdge.html +323 -0
  206. package/docs/interfaces/datatypes.TLSEdgeCreate.html +266 -0
  207. package/docs/interfaces/{datatypes.EventStreamList.html → datatypes.TLSEdgeList.html} +23 -23
  208. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +285 -0
  209. package/docs/interfaces/datatypes.Tunnel.html +85 -9
  210. package/docs/interfaces/datatypes.TunnelGroupBackend.html +281 -0
  211. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +205 -0
  212. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +205 -0
  213. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +219 -0
  214. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  215. package/docs/interfaces/datatypes.TunnelSession.html +10 -10
  216. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  217. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  218. package/docs/interfaces/{datatypes.EventStreamCreate.html → datatypes.WeightedBackend.html} +44 -44
  219. package/docs/interfaces/datatypes.WeightedBackendCreate.html +205 -0
  220. package/docs/interfaces/datatypes.WeightedBackendList.html +205 -0
  221. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +219 -0
  222. package/docs/modules/datatypes.html +213 -89
  223. package/docs/modules/services.html +89 -33
  224. package/lib/client.d.ts +54 -24
  225. package/lib/client.d.ts.map +1 -1
  226. package/lib/client.js +45 -22
  227. package/lib/client.js.map +1 -1
  228. package/lib/datatypes.d.ts +617 -281
  229. package/lib/datatypes.d.ts.map +1 -1
  230. package/lib/services.d.ts +385 -169
  231. package/lib/services.d.ts.map +1 -1
  232. package/lib/services.js +1432 -597
  233. package/lib/services.js.map +1 -1
  234. package/package.json +2 -2
  235. package/src/client.ts +98 -45
  236. package/src/datatypes.ts +669 -302
  237. package/src/services.ts +1426 -610
  238. package/docs/classes/services.EndpointCircuitBreakerModule.html +0 -369
  239. package/docs/classes/services.EndpointCompressionModule.html +0 -369
  240. package/docs/classes/services.EndpointConfigurations.html +0 -451
  241. package/docs/classes/services.EndpointRequestHeadersModule.html +0 -369
  242. package/docs/classes/services.EndpointWebhookValidationModule.html +0 -369
  243. package/docs/interfaces/datatypes.EndpointLoggingReplace.html +0 -176
  244. package/test/endpointConfigurations.test.js +0 -67
@@ -0,0 +1,238 @@
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>TCPEdgeCreate | @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.TCPEdgeCreate.html">TCPEdgeCreate</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface TCPEdgeCreate</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">TCPEdgeCreate</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.TCPEdgeCreate.html#backend" class="tsd-kind-icon">backend</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeCreate.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeCreate.html#hostports" class="tsd-kind-icon">hostports</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeCreate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
91
+ </ul>
92
+ </section>
93
+ </div>
94
+ </section>
95
+ </section>
96
+ <section class="tsd-panel-group tsd-member-group ">
97
+ <h2>Properties</h2>
98
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
99
+ <a name="backend" class="tsd-anchor"></a>
100
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> backend</h3>
101
+ <div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackendMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackendMutate</a></div>
102
+ <aside class="tsd-sources">
103
+ <ul>
104
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L973">datatypes.ts:973</a></li>
105
+ </ul>
106
+ </aside>
107
+ <div class="tsd-comment tsd-typography">
108
+ <div class="lead">
109
+ <p>edge modules</p>
110
+ </div>
111
+ </div>
112
+ </section>
113
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
114
+ <a name="description" class="tsd-anchor"></a>
115
+ <h3>description</h3>
116
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
117
+ <aside class="tsd-sources">
118
+ <ul>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L967">datatypes.ts:967</a></li>
120
+ </ul>
121
+ </aside>
122
+ <div class="tsd-comment tsd-typography">
123
+ <div class="lead">
124
+ <p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
125
+ </div>
126
+ </div>
127
+ </section>
128
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
129
+ <a name="hostports" class="tsd-anchor"></a>
130
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> hostports</h3>
131
+ <div class="tsd-signature tsd-kind-icon">hostports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
132
+ <aside class="tsd-sources">
133
+ <ul>
134
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L971">datatypes.ts:971</a></li>
135
+ </ul>
136
+ </aside>
137
+ <div class="tsd-comment tsd-typography">
138
+ <div class="lead">
139
+ <p>hostports served by this edge</p>
140
+ </div>
141
+ </div>
142
+ </section>
143
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
144
+ <a name="ipRestriction" class="tsd-anchor"></a>
145
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip<wbr>Restriction</h3>
146
+ <div class="tsd-signature tsd-kind-icon">ip<wbr>Restriction<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicyMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicyMutate</a></div>
147
+ <aside class="tsd-sources">
148
+ <ul>
149
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L974">datatypes.ts:974</a></li>
150
+ </ul>
151
+ </aside>
152
+ </section>
153
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
154
+ <a name="metadata" class="tsd-anchor"></a>
155
+ <h3>metadata</h3>
156
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
157
+ <aside class="tsd-sources">
158
+ <ul>
159
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L969">datatypes.ts:969</a></li>
160
+ </ul>
161
+ </aside>
162
+ <div class="tsd-comment tsd-typography">
163
+ <div class="lead">
164
+ <p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
165
+ </div>
166
+ </div>
167
+ </section>
168
+ </section>
169
+ </div>
170
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
171
+ <nav class="tsd-navigation primary">
172
+ <ul>
173
+ <li class=" ">
174
+ <a href="../modules.html">Modules</a>
175
+ </li>
176
+ <li class=" tsd-kind-module">
177
+ <a href="../modules/client.html">client</a>
178
+ </li>
179
+ <li class="current tsd-kind-module">
180
+ <a href="../modules/datatypes.html">datatypes</a>
181
+ </li>
182
+ <li class=" tsd-kind-module">
183
+ <a href="../modules/services.html">services</a>
184
+ </li>
185
+ </ul>
186
+ </nav>
187
+ <nav class="tsd-navigation secondary menu-sticky">
188
+ <ul class="before-current">
189
+ </ul>
190
+ <ul class="current">
191
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
192
+ <a href="datatypes.TCPEdgeCreate.html" class="tsd-kind-icon">TCPEdge<wbr>Create</a>
193
+ <ul>
194
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
195
+ <a href="datatypes.TCPEdgeCreate.html#backend" class="tsd-kind-icon">backend</a>
196
+ </li>
197
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
198
+ <a href="datatypes.TCPEdgeCreate.html#description" class="tsd-kind-icon">description</a>
199
+ </li>
200
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
201
+ <a href="datatypes.TCPEdgeCreate.html#hostports" class="tsd-kind-icon">hostports</a>
202
+ </li>
203
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
204
+ <a href="datatypes.TCPEdgeCreate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a>
205
+ </li>
206
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
207
+ <a href="datatypes.TCPEdgeCreate.html#metadata" class="tsd-kind-icon">metadata</a>
208
+ </li>
209
+ </ul>
210
+ </li>
211
+ </ul>
212
+ <ul class="after-current">
213
+ </ul>
214
+ </nav>
215
+ </div>
216
+ </div>
217
+ </div>
218
+ <footer class="with-border-bottom">
219
+ <div class="container">
220
+ <h2>Legend</h2>
221
+ <div class="tsd-legend-group">
222
+ <ul class="tsd-legend">
223
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
224
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
225
+ </ul>
226
+ <ul class="tsd-legend">
227
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
228
+ </ul>
229
+ </div>
230
+ </div>
231
+ </footer>
232
+ <div class="container tsd-generator">
233
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
234
+ </div>
235
+ <div class="overlay"></div>
236
+ <script src="../assets/js/main.js"></script>
237
+ </body>
238
+ </html>
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta charset="utf-8">
5
5
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>IPWhitelistEntryList | @ngrok/ngrok-api</title>
6
+ <title>TCPEdgeList | @ngrok/ngrok-api</title>
7
7
  <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
8
  <meta name="viewport" content="width=device-width, initial-scale=1">
9
9
  <link rel="stylesheet" href="../assets/css/main.css">
@@ -58,10 +58,10 @@
58
58
  <a href="../modules/datatypes.html">datatypes</a>
59
59
  </li>
60
60
  <li>
61
- <a href="datatypes.IPWhitelistEntryList.html">IPWhitelistEntryList</a>
61
+ <a href="datatypes.TCPEdgeList.html">TCPEdgeList</a>
62
62
  </li>
63
63
  </ul>
64
- <h1>Interface IPWhitelistEntryList</h1>
64
+ <h1>Interface TCPEdgeList</h1>
65
65
  </div>
66
66
  </div>
67
67
  </header>
@@ -72,7 +72,7 @@
72
72
  <h3>Hierarchy</h3>
73
73
  <ul class="tsd-hierarchy">
74
74
  <li>
75
- <span class="target">IPWhitelistEntryList</span>
75
+ <span class="target">TCPEdgeList</span>
76
76
  </li>
77
77
  </ul>
78
78
  </section>
@@ -83,9 +83,9 @@
83
83
  <section class="tsd-index-section ">
84
84
  <h3>Properties</h3>
85
85
  <ul class="tsd-index-list">
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPWhitelistEntryList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPWhitelistEntryList.html#uri" class="tsd-kind-icon">uri</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPWhitelistEntryList.html#whitelist" class="tsd-kind-icon">whitelist</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeList.html#tcpEdges" class="tsd-kind-icon">tcp<wbr>Edges</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeList.html#uri" class="tsd-kind-icon">uri</a></li>
89
89
  </ul>
90
90
  </section>
91
91
  </div>
@@ -99,7 +99,7 @@
99
99
  <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>
100
100
  <aside class="tsd-sources">
101
101
  <ul>
102
- <li>Defined in datatypes.ts:996</li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L962">datatypes.ts:962</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  <div class="tsd-comment tsd-typography">
@@ -109,32 +109,32 @@
109
109
  </div>
110
110
  </section>
111
111
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
112
- <a name="uri" class="tsd-anchor"></a>
113
- <h3>uri</h3>
114
- <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
112
+ <a name="tcpEdges" class="tsd-anchor"></a>
113
+ <h3>tcp<wbr>Edges</h3>
114
+ <div class="tsd-signature tsd-kind-icon">tcp<wbr>Edges<span class="tsd-signature-symbol">:</span> <a href="datatypes.TCPEdge.html" class="tsd-signature-type" data-tsd-kind="Interface">TCPEdge</a><span class="tsd-signature-symbol">[]</span></div>
115
115
  <aside class="tsd-sources">
116
116
  <ul>
117
- <li>Defined in datatypes.ts:994</li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L958">datatypes.ts:958</a></li>
118
118
  </ul>
119
119
  </aside>
120
120
  <div class="tsd-comment tsd-typography">
121
121
  <div class="lead">
122
- <p>URI of the IP whitelist API resource</p>
122
+ <p>the list of all TCP Edges on this account</p>
123
123
  </div>
124
124
  </div>
125
125
  </section>
126
126
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
127
- <a name="whitelist" class="tsd-anchor"></a>
128
- <h3>whitelist</h3>
129
- <div class="tsd-signature tsd-kind-icon">whitelist<span class="tsd-signature-symbol">:</span> <a href="datatypes.IPWhitelistEntry.html" class="tsd-signature-type" data-tsd-kind="Interface">IPWhitelistEntry</a><span class="tsd-signature-symbol">[]</span></div>
127
+ <a name="uri" class="tsd-anchor"></a>
128
+ <h3>uri</h3>
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 datatypes.ts:992</li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L960">datatypes.ts:960</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <div class="tsd-comment tsd-typography">
136
136
  <div class="lead">
137
- <p>the list of all IP whitelist entries on this account</p>
137
+ <p>URI of the TCP Edge list API resource</p>
138
138
  </div>
139
139
  </div>
140
140
  </section>
@@ -162,16 +162,16 @@
162
162
  </ul>
163
163
  <ul class="current">
164
164
  <li class="current tsd-kind-interface tsd-parent-kind-module">
165
- <a href="datatypes.IPWhitelistEntryList.html" class="tsd-kind-icon">IPWhitelist<wbr>Entry<wbr>List</a>
165
+ <a href="datatypes.TCPEdgeList.html" class="tsd-kind-icon">TCPEdge<wbr>List</a>
166
166
  <ul>
167
167
  <li class=" tsd-kind-property tsd-parent-kind-interface">
168
- <a href="datatypes.IPWhitelistEntryList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a>
168
+ <a href="datatypes.TCPEdgeList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a>
169
169
  </li>
170
170
  <li class=" tsd-kind-property tsd-parent-kind-interface">
171
- <a href="datatypes.IPWhitelistEntryList.html#uri" class="tsd-kind-icon">uri</a>
171
+ <a href="datatypes.TCPEdgeList.html#tcpEdges" class="tsd-kind-icon">tcp<wbr>Edges</a>
172
172
  </li>
173
173
  <li class=" tsd-kind-property tsd-parent-kind-interface">
174
- <a href="datatypes.IPWhitelistEntryList.html#whitelist" class="tsd-kind-icon">whitelist</a>
174
+ <a href="datatypes.TCPEdgeList.html#uri" class="tsd-kind-icon">uri</a>
175
175
  </li>
176
176
  </ul>
177
177
  </li>
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta charset="utf-8">
5
5
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>EventStreamUpdate | @ngrok/ngrok-api</title>
6
+ <title>TCPEdgeUpdate | @ngrok/ngrok-api</title>
7
7
  <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
8
  <meta name="viewport" content="width=device-width, initial-scale=1">
9
9
  <link rel="stylesheet" href="../assets/css/main.css">
@@ -58,10 +58,10 @@
58
58
  <a href="../modules/datatypes.html">datatypes</a>
59
59
  </li>
60
60
  <li>
61
- <a href="datatypes.EventStreamUpdate.html">EventStreamUpdate</a>
61
+ <a href="datatypes.TCPEdgeUpdate.html">TCPEdgeUpdate</a>
62
62
  </li>
63
63
  </ul>
64
- <h1>Interface EventStreamUpdate</h1>
64
+ <h1>Interface TCPEdgeUpdate</h1>
65
65
  </div>
66
66
  </div>
67
67
  </header>
@@ -72,7 +72,7 @@
72
72
  <h3>Hierarchy</h3>
73
73
  <ul class="tsd-hierarchy">
74
74
  <li>
75
- <span class="target">EventStreamUpdate</span>
75
+ <span class="target">TCPEdgeUpdate</span>
76
76
  </li>
77
77
  </ul>
78
78
  </section>
@@ -83,12 +83,12 @@
83
83
  <section class="tsd-index-section ">
84
84
  <h3>Properties</h3>
85
85
  <ul class="tsd-index-list">
86
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventStreamUpdate.html#description" class="tsd-kind-icon">description</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventStreamUpdate.html#destinationIds" class="tsd-kind-icon">destination<wbr>Ids</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventStreamUpdate.html#fields" class="tsd-kind-icon">fields</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventStreamUpdate.html#id" class="tsd-kind-icon">id</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventStreamUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventStreamUpdate.html#samplingRate" class="tsd-kind-icon">sampling<wbr>Rate</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeUpdate.html#backend" class="tsd-kind-icon">backend</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeUpdate.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeUpdate.html#hostports" class="tsd-kind-icon">hostports</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeUpdate.html#id" class="tsd-kind-icon">id</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeUpdate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TCPEdgeUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
92
92
  </ul>
93
93
  </section>
94
94
  </div>
@@ -97,47 +97,47 @@
97
97
  <section class="tsd-panel-group tsd-member-group ">
98
98
  <h2>Properties</h2>
99
99
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
100
- <a name="description" class="tsd-anchor"></a>
101
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
102
- <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
+ <a name="backend" class="tsd-anchor"></a>
101
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> backend</h3>
102
+ <div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackendMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackendMutate</a></div>
103
103
  <aside class="tsd-sources">
104
104
  <ul>
105
- <li>Defined in datatypes.ts:582</li>
105
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L987">datatypes.ts:987</a></li>
106
106
  </ul>
107
107
  </aside>
108
108
  <div class="tsd-comment tsd-typography">
109
109
  <div class="lead">
110
- <p>Human-readable description of the Event Stream. Optional, max 255 bytes.</p>
110
+ <p>edge modules</p>
111
111
  </div>
112
112
  </div>
113
113
  </section>
114
114
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
115
- <a name="destinationIds" class="tsd-anchor"></a>
116
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> destination<wbr>Ids</h3>
117
- <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>
115
+ <a name="description" class="tsd-anchor"></a>
116
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
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 datatypes.ts:586</li>
120
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L981">datatypes.ts:981</a></li>
121
121
  </ul>
122
122
  </aside>
123
123
  <div class="tsd-comment tsd-typography">
124
124
  <div class="lead">
125
- <p>A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</p>
125
+ <p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
126
126
  </div>
127
127
  </div>
128
128
  </section>
129
129
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
130
- <a name="fields" class="tsd-anchor"></a>
131
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> fields</h3>
132
- <div class="tsd-signature tsd-kind-icon">fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
130
+ <a name="hostports" class="tsd-anchor"></a>
131
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> hostports</h3>
132
+ <div class="tsd-signature tsd-kind-icon">hostports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
133
133
  <aside class="tsd-sources">
134
134
  <ul>
135
- <li>Defined in datatypes.ts:584</li>
135
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L985">datatypes.ts:985</a></li>
136
136
  </ul>
137
137
  </aside>
138
138
  <div class="tsd-comment tsd-typography">
139
139
  <div class="lead">
140
- <p>A list of protocol-specific fields you want to collect on each event.</p>
140
+ <p>hostports served by this edge</p>
141
141
  </div>
142
142
  </div>
143
143
  </section>
@@ -147,42 +147,37 @@
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 datatypes.ts:578</li>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L979">datatypes.ts:979</a></li>
151
151
  </ul>
152
152
  </aside>
153
153
  <div class="tsd-comment tsd-typography">
154
154
  <div class="lead">
155
- <p>Unique identifier for this Event Stream.</p>
155
+ <p>unique identifier of this edge</p>
156
156
  </div>
157
157
  </div>
158
158
  </section>
159
159
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
160
- <a name="metadata" class="tsd-anchor"></a>
161
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
162
- <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
160
+ <a name="ipRestriction" class="tsd-anchor"></a>
161
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip<wbr>Restriction</h3>
162
+ <div class="tsd-signature tsd-kind-icon">ip<wbr>Restriction<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicyMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicyMutate</a></div>
163
163
  <aside class="tsd-sources">
164
164
  <ul>
165
- <li>Defined in datatypes.ts:580</li>
165
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L988">datatypes.ts:988</a></li>
166
166
  </ul>
167
167
  </aside>
168
- <div class="tsd-comment tsd-typography">
169
- <div class="lead">
170
- <p>Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.</p>
171
- </div>
172
- </div>
173
168
  </section>
174
169
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
175
- <a name="samplingRate" class="tsd-anchor"></a>
176
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> sampling<wbr>Rate</h3>
177
- <div class="tsd-signature tsd-kind-icon">sampling<wbr>Rate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
170
+ <a name="metadata" class="tsd-anchor"></a>
171
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
172
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
178
173
  <aside class="tsd-sources">
179
174
  <ul>
180
- <li>Defined in datatypes.ts:588</li>
175
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L983">datatypes.ts:983</a></li>
181
176
  </ul>
182
177
  </aside>
183
178
  <div class="tsd-comment tsd-typography">
184
179
  <div class="lead">
185
- <p>The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p>
180
+ <p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
186
181
  </div>
187
182
  </div>
188
183
  </section>
@@ -210,25 +205,25 @@
210
205
  </ul>
211
206
  <ul class="current">
212
207
  <li class="current tsd-kind-interface tsd-parent-kind-module">
213
- <a href="datatypes.EventStreamUpdate.html" class="tsd-kind-icon">Event<wbr>Stream<wbr>Update</a>
208
+ <a href="datatypes.TCPEdgeUpdate.html" class="tsd-kind-icon">TCPEdge<wbr>Update</a>
214
209
  <ul>
215
210
  <li class=" tsd-kind-property tsd-parent-kind-interface">
216
- <a href="datatypes.EventStreamUpdate.html#description" class="tsd-kind-icon">description</a>
211
+ <a href="datatypes.TCPEdgeUpdate.html#backend" class="tsd-kind-icon">backend</a>
217
212
  </li>
218
213
  <li class=" tsd-kind-property tsd-parent-kind-interface">
219
- <a href="datatypes.EventStreamUpdate.html#destinationIds" class="tsd-kind-icon">destination<wbr>Ids</a>
214
+ <a href="datatypes.TCPEdgeUpdate.html#description" class="tsd-kind-icon">description</a>
220
215
  </li>
221
216
  <li class=" tsd-kind-property tsd-parent-kind-interface">
222
- <a href="datatypes.EventStreamUpdate.html#fields" class="tsd-kind-icon">fields</a>
217
+ <a href="datatypes.TCPEdgeUpdate.html#hostports" class="tsd-kind-icon">hostports</a>
223
218
  </li>
224
219
  <li class=" tsd-kind-property tsd-parent-kind-interface">
225
- <a href="datatypes.EventStreamUpdate.html#id" class="tsd-kind-icon">id</a>
220
+ <a href="datatypes.TCPEdgeUpdate.html#id" class="tsd-kind-icon">id</a>
226
221
  </li>
227
222
  <li class=" tsd-kind-property tsd-parent-kind-interface">
228
- <a href="datatypes.EventStreamUpdate.html#metadata" class="tsd-kind-icon">metadata</a>
223
+ <a href="datatypes.TCPEdgeUpdate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a>
229
224
  </li>
230
225
  <li class=" tsd-kind-property tsd-parent-kind-interface">
231
- <a href="datatypes.EventStreamUpdate.html#samplingRate" class="tsd-kind-icon">sampling<wbr>Rate</a>
226
+ <a href="datatypes.TCPEdgeUpdate.html#metadata" class="tsd-kind-icon">metadata</a>
232
227
  </li>
233
228
  </ul>
234
229
  </li>