@ngrok/ngrok-api 0.3.0 → 0.7.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 (242) hide show
  1. package/README.md +0 -28
  2. package/docs/assets/js/search.js +1 -1
  3. package/docs/classes/client.Ngrok.html +191 -100
  4. package/docs/classes/services.APIKeys.html +6 -105
  5. package/docs/classes/services.AbuseReports.html +3 -102
  6. package/docs/classes/services.AgentIngresses.html +6 -105
  7. package/docs/classes/services.CertificateAuthorities.html +6 -105
  8. package/docs/classes/services.Credentials.html +6 -105
  9. package/docs/classes/services.EdgeRouteBackendModule.html +270 -0
  10. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +270 -0
  11. package/docs/classes/services.EdgeRouteCompressionModule.html +270 -0
  12. package/docs/classes/{services.EndpointCircuitBreakerModule.html → services.EdgeRouteIPRestrictionModule.html} +28 -127
  13. package/docs/classes/services.EdgeRouteOAuthModule.html +270 -0
  14. package/docs/classes/services.EdgeRouteOIDCModule.html +270 -0
  15. package/docs/classes/{services.EndpointResponseHeadersModule.html → services.EdgeRouteRequestHeadersModule.html} +28 -127
  16. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +270 -0
  17. package/docs/classes/services.EdgeRouteSAMLModule.html +270 -0
  18. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +270 -0
  19. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +270 -0
  20. package/docs/classes/services.EdgesHTTPS.html +343 -0
  21. package/docs/classes/services.EdgesHTTPSRoutes.html +317 -0
  22. package/docs/classes/services.EdgesTCP.html +343 -0
  23. package/docs/classes/services.EdgesTLS.html +343 -0
  24. package/docs/classes/services.Endpoints.html +256 -0
  25. package/docs/classes/services.EventDestinations.html +7 -106
  26. package/docs/classes/services.EventSources.html +6 -105
  27. package/docs/classes/services.EventSubscriptions.html +6 -105
  28. package/docs/classes/services.FailoverBackends.html +353 -0
  29. package/docs/classes/services.HTTPResponseBackends.html +318 -0
  30. package/docs/classes/{services.EndpointMutualTLSModule.html → services.HTTPSEdgeMutualTLSModule.html} +22 -121
  31. package/docs/classes/{services.EndpointTLSTerminationModule.html → services.HTTPSEdgeTLSTerminationModule.html} +22 -121
  32. package/docs/classes/services.IPPolicies.html +6 -105
  33. package/docs/classes/services.IPPolicyRules.html +6 -105
  34. package/docs/classes/services.IPRestrictions.html +7 -106
  35. package/docs/classes/services.ReservedAddrs.html +6 -137
  36. package/docs/classes/services.ReservedDomains.html +8 -171
  37. package/docs/classes/services.SSHCertificateAuthorities.html +6 -105
  38. package/docs/classes/services.SSHCredentials.html +6 -105
  39. package/docs/classes/services.SSHHostCertificates.html +6 -105
  40. package/docs/classes/services.SSHUserCertificates.html +6 -105
  41. package/docs/classes/{services.EndpointSAMLModule.html → services.TCPEdgeBackendModule.html} +25 -124
  42. package/docs/classes/{services.EndpointIPPolicyModule.html → services.TCPEdgeIPRestrictionModule.html} +22 -121
  43. package/docs/classes/services.TLSCertificates.html +6 -105
  44. package/docs/classes/{services.EndpointLoggingModule.html → services.TLSEdgeBackendModule.html} +25 -124
  45. package/docs/classes/{services.EndpointOIDCModule.html → services.TLSEdgeIPRestrictionModule.html} +25 -124
  46. package/docs/classes/{services.EndpointOAuthModule.html → services.TLSEdgeMutualTLSModule.html} +25 -124
  47. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +270 -0
  48. package/docs/classes/services.TunnelGroupBackends.html +351 -0
  49. package/docs/classes/services.TunnelSessions.html +6 -105
  50. package/docs/classes/services.Tunnels.html +34 -101
  51. package/docs/classes/{services.EventStreams.html → services.WeightedBackends.html} +51 -140
  52. package/docs/index.html +0 -27
  53. package/docs/interfaces/client.NgrokConfig.html +2 -2
  54. package/docs/interfaces/datatypes.APIKey.html +6 -6
  55. package/docs/interfaces/datatypes.APIKeyCreate.html +2 -2
  56. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  57. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  58. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  59. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  60. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  61. package/docs/interfaces/datatypes.AbuseReport.html +7 -7
  62. package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
  63. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  64. package/docs/interfaces/datatypes.AgentIngress.html +8 -8
  65. package/docs/interfaces/datatypes.AgentIngressCreate.html +3 -3
  66. package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
  67. package/docs/interfaces/datatypes.AgentIngressUpdate.html +3 -3
  68. package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
  69. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
  70. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  71. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  72. package/docs/interfaces/datatypes.Credential.html +7 -7
  73. package/docs/interfaces/datatypes.CredentialCreate.html +3 -3
  74. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  75. package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
  76. package/docs/interfaces/{datatypes.EndpointOIDCReplace.html → datatypes.EdgeBackendReplace.html} +12 -12
  77. package/docs/interfaces/{datatypes.EndpointIPPolicyReplace.html → datatypes.EdgeIPRestrictionReplace.html} +11 -11
  78. package/docs/interfaces/{datatypes.EndpointMutualTLSReplace.html → datatypes.EdgeMutualTLSReplace.html} +11 -11
  79. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +190 -0
  80. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +190 -0
  81. package/docs/interfaces/{datatypes.EndpointCompressionReplace.html → datatypes.EdgeRouteCompressionReplace.html} +25 -11
  82. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +190 -0
  83. package/docs/interfaces/{datatypes.EndpointCircuitBreakerReplace.html → datatypes.EdgeRouteItem.html} +27 -17
  84. package/docs/interfaces/{datatypes.EndpointOAuthReplace.html → datatypes.EdgeRouteOAuthReplace.html} +25 -11
  85. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +190 -0
  86. package/docs/interfaces/{datatypes.EndpointRequestHeadersReplace.html → datatypes.EdgeRouteRequestHeadersReplace.html} +25 -11
  87. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +190 -0
  88. package/docs/interfaces/{datatypes.EndpointSAMLReplace.html → datatypes.EdgeRouteSAMLReplace.html} +25 -11
  89. package/docs/interfaces/{datatypes.EndpointWebhookValidationReplace.html → datatypes.EdgeRouteWebhookVerificationReplace.html} +25 -11
  90. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +190 -0
  91. package/docs/interfaces/{datatypes.EndpointResponseHeadersReplace.html → datatypes.EdgeTLSTerminationAtEdgeReplace.html} +12 -12
  92. package/docs/interfaces/{datatypes.EndpointTLSTerminationReplace.html → datatypes.EdgeTLSTerminationReplace.html} +11 -11
  93. package/docs/interfaces/datatypes.Endpoint.html +395 -0
  94. package/docs/interfaces/{datatypes.EndpointLogging.html → datatypes.EndpointBackend.html} +19 -19
  95. package/docs/interfaces/{datatypes.EndpointLoggingMutate.html → datatypes.EndpointBackendMutate.html} +19 -19
  96. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  97. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  98. package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
  99. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  100. package/docs/interfaces/datatypes.EndpointList.html +205 -0
  101. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  102. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  103. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  104. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  105. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
  106. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  107. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  108. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +4 -4
  109. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  110. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  111. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  112. package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
  113. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
  114. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  115. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +186 -0
  116. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
  117. package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +167 -0
  118. package/docs/interfaces/datatypes.Error.html +4 -4
  119. package/docs/interfaces/datatypes.EventDestination.html +7 -7
  120. package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
  121. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  122. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  123. package/docs/interfaces/datatypes.EventSource.html +2 -2
  124. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  125. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  126. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  127. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  128. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  129. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  130. package/docs/interfaces/datatypes.EventSubscription.html +7 -7
  131. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +5 -5
  132. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  133. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +6 -6
  134. package/docs/interfaces/datatypes.EventTarget.html +3 -3
  135. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  136. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  137. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  138. package/docs/interfaces/{datatypes.EventStreamCreate.html → datatypes.FailoverBackend.html} +44 -44
  139. package/docs/interfaces/datatypes.FailoverBackendCreate.html +205 -0
  140. package/docs/interfaces/datatypes.FailoverBackendList.html +205 -0
  141. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +219 -0
  142. package/docs/interfaces/datatypes.HTTPResponseBackend.html +295 -0
  143. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +243 -0
  144. package/docs/interfaces/datatypes.HTTPResponseBackendList.html +190 -0
  145. package/docs/interfaces/{datatypes.EventStreamUpdate.html → datatypes.HTTPResponseBackendUpdate.html} +40 -45
  146. package/docs/interfaces/{datatypes.EventStream.html → datatypes.HTTPSEdge.html} +58 -63
  147. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +238 -0
  148. package/docs/interfaces/{datatypes.EventStreamList.html → datatypes.HTTPSEdgeList.html} +20 -20
  149. package/docs/interfaces/{datatypes.EndpointConfiguration.html → datatypes.HTTPSEdgeRoute.html} +123 -104
  150. package/docs/interfaces/{datatypes.EndpointConfigurationCreate.html → datatypes.HTTPSEdgeRouteCreate.html} +108 -89
  151. package/docs/interfaces/{datatypes.EndpointConfigurationUpdate.html → datatypes.HTTPSEdgeRouteUpdate.html} +115 -77
  152. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +257 -0
  153. package/docs/interfaces/datatypes.IPPolicy.html +5 -24
  154. package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -21
  155. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  156. package/docs/interfaces/datatypes.IPPolicyRule.html +26 -7
  157. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +23 -4
  158. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  159. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  160. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  161. package/docs/interfaces/datatypes.IPRestriction.html +8 -8
  162. package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
  163. package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
  164. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  165. package/docs/interfaces/datatypes.Item.html +1 -1
  166. package/docs/interfaces/datatypes.Paging.html +2 -2
  167. package/docs/interfaces/datatypes.Ref.html +2 -2
  168. package/docs/interfaces/datatypes.ReservedAddr.html +7 -26
  169. package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -22
  170. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  171. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -22
  172. package/docs/interfaces/datatypes.ReservedDomain.html +12 -50
  173. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -4
  174. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  175. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
  176. package/docs/interfaces/datatypes.ReservedDomainCreate.html +6 -44
  177. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  178. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -43
  179. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
  180. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
  181. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  182. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  183. package/docs/interfaces/datatypes.SSHCredential.html +7 -7
  184. package/docs/interfaces/datatypes.SSHCredentialCreate.html +4 -4
  185. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  186. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
  187. package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
  188. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
  189. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  190. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  191. package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
  192. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
  193. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  194. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  195. package/docs/interfaces/datatypes.TCPEdge.html +295 -0
  196. package/docs/interfaces/datatypes.TCPEdgeCreate.html +238 -0
  197. package/docs/interfaces/datatypes.TCPEdgeList.html +205 -0
  198. package/docs/interfaces/datatypes.TCPEdgeUpdate.html +257 -0
  199. package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
  200. package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
  201. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  202. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  203. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  204. package/docs/interfaces/datatypes.TLSEdge.html +323 -0
  205. package/docs/interfaces/datatypes.TLSEdgeCreate.html +266 -0
  206. package/docs/interfaces/datatypes.TLSEdgeList.html +205 -0
  207. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +285 -0
  208. package/docs/interfaces/datatypes.Tunnel.html +85 -9
  209. package/docs/interfaces/datatypes.TunnelGroupBackend.html +281 -0
  210. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +205 -0
  211. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +205 -0
  212. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +219 -0
  213. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  214. package/docs/interfaces/datatypes.TunnelSession.html +10 -10
  215. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  216. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  217. package/docs/interfaces/datatypes.WeightedBackend.html +262 -0
  218. package/docs/interfaces/datatypes.WeightedBackendCreate.html +205 -0
  219. package/docs/interfaces/{datatypes.EndpointConfigurationList.html → datatypes.WeightedBackendList.html} +19 -19
  220. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +219 -0
  221. package/docs/modules/datatypes.html +197 -69
  222. package/docs/modules/services.html +85 -29
  223. package/lib/client.d.ts +53 -19
  224. package/lib/client.d.ts.map +1 -1
  225. package/lib/client.js +42 -18
  226. package/lib/client.js.map +1 -1
  227. package/lib/datatypes.d.ts +570 -236
  228. package/lib/datatypes.d.ts.map +1 -1
  229. package/lib/services.d.ts +358 -138
  230. package/lib/services.d.ts.map +1 -1
  231. package/lib/services.js +1367 -528
  232. package/lib/services.js.map +1 -1
  233. package/package.json +2 -2
  234. package/src/client.ts +95 -38
  235. package/src/datatypes.ts +618 -252
  236. package/src/services.ts +1363 -543
  237. package/docs/classes/services.EndpointCompressionModule.html +0 -369
  238. package/docs/classes/services.EndpointConfigurations.html +0 -451
  239. package/docs/classes/services.EndpointRequestHeadersModule.html +0 -369
  240. package/docs/classes/services.EndpointWebhookValidationModule.html +0 -369
  241. package/docs/interfaces/datatypes.EndpointLoggingReplace.html +0 -176
  242. package/test/endpointConfigurations.test.js +0 -67
@@ -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>EventStreamList | @ngrok/ngrok-api</title>
6
+ <title>HTTPSEdgeList | @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.EventStreamList.html">EventStreamList</a>
61
+ <a href="datatypes.HTTPSEdgeList.html">HTTPSEdgeList</a>
62
62
  </li>
63
63
  </ul>
64
- <h1>Interface EventStreamList</h1>
64
+ <h1>Interface HTTPSEdgeList</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">EventStreamList</span>
75
+ <span class="target">HTTPSEdgeList</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.EventStreamList.html#eventStreams" class="tsd-kind-icon">event<wbr>Streams</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventStreamList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EventStreamList.html#uri" class="tsd-kind-icon">uri</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeList.html#httpsEdges" class="tsd-kind-icon">https<wbr>Edges</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeList.html#uri" class="tsd-kind-icon">uri</a></li>
89
89
  </ul>
90
90
  </section>
91
91
  </div>
@@ -94,17 +94,17 @@
94
94
  <section class="tsd-panel-group tsd-member-group ">
95
95
  <h2>Properties</h2>
96
96
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
97
- <a name="eventStreams" class="tsd-anchor"></a>
98
- <h3>event<wbr>Streams</h3>
99
- <div class="tsd-signature tsd-kind-icon">event<wbr>Streams<span class="tsd-signature-symbol">:</span> <a href="datatypes.EventStream.html" class="tsd-signature-type" data-tsd-kind="Interface">EventStream</a><span class="tsd-signature-symbol">[]</span></div>
97
+ <a name="httpsEdges" class="tsd-anchor"></a>
98
+ <h3>https<wbr>Edges</h3>
99
+ <div class="tsd-signature tsd-kind-icon">https<wbr>Edges<span class="tsd-signature-symbol">:</span> <a href="datatypes.HTTPSEdge.html" class="tsd-signature-type" data-tsd-kind="Interface">HTTPSEdge</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/1a198cb/src/datatypes.ts#L642">datatypes.ts:642</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L812">datatypes.ts:812</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  <div class="tsd-comment tsd-typography">
106
106
  <div class="lead">
107
- <p>The list of all Event Streams on this account.</p>
107
+ <p>the list of all HTTPS Edges on this account</p>
108
108
  </div>
109
109
  </div>
110
110
  </section>
@@ -114,12 +114,12 @@
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/1a198cb/src/datatypes.ts#L646">datatypes.ts:646</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L816">datatypes.ts:816</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 next page, or null if there is no next page.</p>
122
+ <p>URI of the next page, or null if there is no next page</p>
123
123
  </div>
124
124
  </div>
125
125
  </section>
@@ -129,12 +129,12 @@
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/1a198cb/src/datatypes.ts#L644">datatypes.ts:644</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L814">datatypes.ts:814</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <div class="tsd-comment tsd-typography">
136
136
  <div class="lead">
137
- <p>URI of the Event Stream list API resource.</p>
137
+ <p>URI of the HTTPS 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.EventStreamList.html" class="tsd-kind-icon">Event<wbr>Stream<wbr>List</a>
165
+ <a href="datatypes.HTTPSEdgeList.html" class="tsd-kind-icon">HTTPSEdge<wbr>List</a>
166
166
  <ul>
167
167
  <li class=" tsd-kind-property tsd-parent-kind-interface">
168
- <a href="datatypes.EventStreamList.html#eventStreams" class="tsd-kind-icon">event<wbr>Streams</a>
168
+ <a href="datatypes.HTTPSEdgeList.html#httpsEdges" class="tsd-kind-icon">https<wbr>Edges</a>
169
169
  </li>
170
170
  <li class=" tsd-kind-property tsd-parent-kind-interface">
171
- <a href="datatypes.EventStreamList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a>
171
+ <a href="datatypes.HTTPSEdgeList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a>
172
172
  </li>
173
173
  <li class=" tsd-kind-property tsd-parent-kind-interface">
174
- <a href="datatypes.EventStreamList.html#uri" class="tsd-kind-icon">uri</a>
174
+ <a href="datatypes.HTTPSEdgeList.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>EndpointConfiguration | @ngrok/ngrok-api</title>
6
+ <title>HTTPSEdgeRoute | @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.EndpointConfiguration.html">EndpointConfiguration</a>
61
+ <a href="datatypes.HTTPSEdgeRoute.html">HTTPSEdgeRoute</a>
62
62
  </li>
63
63
  </ul>
64
- <h1>Interface EndpointConfiguration</h1>
64
+ <h1>Interface HTTPSEdgeRoute</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">EndpointConfiguration</span>
75
+ <span class="target">HTTPSEdgeRoute</span>
76
76
  </li>
77
77
  </ul>
78
78
  </section>
@@ -83,24 +83,25 @@
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.EndpointConfiguration.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a></li>
87
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#compression" class="tsd-kind-icon">compression</a></li>
88
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
89
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#description" class="tsd-kind-icon">description</a></li>
90
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#id" class="tsd-kind-icon">id</a></li>
91
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#ipPolicy" class="tsd-kind-icon">ip<wbr>Policy</a></li>
92
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#logging" class="tsd-kind-icon">logging</a></li>
93
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#metadata" class="tsd-kind-icon">metadata</a></li>
94
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a></li>
95
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#oauth" class="tsd-kind-icon">oauth</a></li>
96
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#oidc" class="tsd-kind-icon">oidc</a></li>
97
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a></li>
98
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a></li>
99
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#saml" class="tsd-kind-icon">saml</a></li>
100
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a></li>
101
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#type" class="tsd-kind-icon">type</a></li>
102
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#uri" class="tsd-kind-icon">uri</a></li>
103
- <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointConfiguration.html#webhookValidation" class="tsd-kind-icon">webhook<wbr>Validation</a></li>
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#backend" class="tsd-kind-icon">backend</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#compression" class="tsd-kind-icon">compression</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#description" class="tsd-kind-icon">description</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#edgeId" class="tsd-kind-icon">edge<wbr>Id</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#id" class="tsd-kind-icon">id</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#match" class="tsd-kind-icon">match</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#matchType" class="tsd-kind-icon">match<wbr>Type</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#metadata" class="tsd-kind-icon">metadata</a></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#oauth" class="tsd-kind-icon">oauth</a></li>
98
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#oidc" class="tsd-kind-icon">oidc</a></li>
99
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a></li>
100
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a></li>
101
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#saml" class="tsd-kind-icon">saml</a></li>
102
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#uri" class="tsd-kind-icon">uri</a></li>
103
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a></li>
104
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRoute.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</a></li>
104
105
  </ul>
105
106
  </section>
106
107
  </div>
@@ -108,13 +109,28 @@
108
109
  </section>
109
110
  <section class="tsd-panel-group tsd-member-group ">
110
111
  <h2>Properties</h2>
112
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
113
+ <a name="backend" class="tsd-anchor"></a>
114
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> backend</h3>
115
+ <div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a></div>
116
+ <aside class="tsd-sources">
117
+ <ul>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L787">datatypes.ts:787</a></li>
119
+ </ul>
120
+ </aside>
121
+ <div class="tsd-comment tsd-typography">
122
+ <div class="lead">
123
+ <p>backend module configuration or <code>null</code></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="circuitBreaker" class="tsd-anchor"></a>
113
129
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> circuit<wbr>Breaker</h3>
114
130
  <div class="tsd-signature tsd-kind-icon">circuit<wbr>Breaker<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCircuitBreaker.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCircuitBreaker</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/1a198cb/src/datatypes.ts#L252">datatypes.ts:252</a></li>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L791">datatypes.ts:791</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">compression<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCompression.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCompression</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/1a198cb/src/datatypes.ts#L254">datatypes.ts:254</a></li>
148
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L793">datatypes.ts:793</a></li>
133
149
  </ul>
134
150
  </aside>
135
151
  <div class="tsd-comment tsd-typography">
@@ -144,12 +160,12 @@
144
160
  <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
145
161
  <aside class="tsd-sources">
146
162
  <ul>
147
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L248">datatypes.ts:248</a></li>
163
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L775">datatypes.ts:775</a></li>
148
164
  </ul>
149
165
  </aside>
150
166
  <div class="tsd-comment tsd-typography">
151
167
  <div class="lead">
152
- <p>timestamp when the endpoint configuration was created, RFC 3339 format</p>
168
+ <p>timestamp when the edge configuration was created, RFC 3339 format</p>
153
169
  </div>
154
170
  </div>
155
171
  </section>
@@ -159,12 +175,27 @@
159
175
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
160
176
  <aside class="tsd-sources">
161
177
  <ul>
162
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L244">datatypes.ts:244</a></li>
178
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L783">datatypes.ts:783</a></li>
179
+ </ul>
180
+ </aside>
181
+ <div class="tsd-comment tsd-typography">
182
+ <div class="lead">
183
+ <p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
184
+ </div>
185
+ </div>
186
+ </section>
187
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
188
+ <a name="edgeId" class="tsd-anchor"></a>
189
+ <h3>edge<wbr>Id</h3>
190
+ <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
191
+ <aside class="tsd-sources">
192
+ <ul>
193
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L771">datatypes.ts:771</a></li>
163
194
  </ul>
164
195
  </aside>
165
196
  <div class="tsd-comment tsd-typography">
166
197
  <div class="lead">
167
- <p>human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p>
198
+ <p>unique identifier of this edge</p>
168
199
  </div>
169
200
  </div>
170
201
  </section>
@@ -174,72 +205,72 @@
174
205
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
175
206
  <aside class="tsd-sources">
176
207
  <ul>
177
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L240">datatypes.ts:240</a></li>
208
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L773">datatypes.ts:773</a></li>
178
209
  </ul>
179
210
  </aside>
180
211
  <div class="tsd-comment tsd-typography">
181
212
  <div class="lead">
182
- <p>unique identifier of this endpoint configuration</p>
213
+ <p>unique identifier of this edge route</p>
183
214
  </div>
184
215
  </div>
185
216
  </section>
186
217
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
187
- <a name="ipPolicy" class="tsd-anchor"></a>
188
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip<wbr>Policy</h3>
189
- <div class="tsd-signature tsd-kind-icon">ip<wbr>Policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a></div>
218
+ <a name="ipRestriction" class="tsd-anchor"></a>
219
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip<wbr>Restriction</h3>
220
+ <div class="tsd-signature tsd-kind-icon">ip<wbr>Restriction<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a></div>
190
221
  <aside class="tsd-sources">
191
222
  <ul>
192
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L260">datatypes.ts:260</a></li>
223
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L789">datatypes.ts:789</a></li>
193
224
  </ul>
194
225
  </aside>
195
226
  <div class="tsd-comment tsd-typography">
196
227
  <div class="lead">
197
- <p>ip policy module configuration or <code>null</code></p>
228
+ <p>ip restriction module configuration or <code>null</code></p>
198
229
  </div>
199
230
  </div>
200
231
  </section>
201
232
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
202
- <a name="logging" class="tsd-anchor"></a>
203
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> logging</h3>
204
- <div class="tsd-signature tsd-kind-icon">logging<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointLogging.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointLogging</a></div>
233
+ <a name="match" class="tsd-anchor"></a>
234
+ <h3>match</h3>
235
+ <div class="tsd-signature tsd-kind-icon">match<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
205
236
  <aside class="tsd-sources">
206
237
  <ul>
207
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L270">datatypes.ts:270</a></li>
238
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L779">datatypes.ts:779</a></li>
208
239
  </ul>
209
240
  </aside>
210
241
  <div class="tsd-comment tsd-typography">
211
242
  <div class="lead">
212
- <p>logging module configuration or <code>null</code></p>
243
+ <p>Route selector: &quot;/blog&quot; or &quot;example.com&quot; or &quot;example.com/blog&quot;</p>
213
244
  </div>
214
245
  </div>
215
246
  </section>
216
247
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
217
- <a name="metadata" class="tsd-anchor"></a>
218
- <h3>metadata</h3>
219
- <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
248
+ <a name="matchType" class="tsd-anchor"></a>
249
+ <h3>match<wbr>Type</h3>
250
+ <div class="tsd-signature tsd-kind-icon">match<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
220
251
  <aside class="tsd-sources">
221
252
  <ul>
222
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L246">datatypes.ts:246</a></li>
253
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L777">datatypes.ts:777</a></li>
223
254
  </ul>
224
255
  </aside>
225
256
  <div class="tsd-comment tsd-typography">
226
257
  <div class="lead">
227
- <p>arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p>
258
+ <p>Type of match to use for this route. Valid values are &quot;exact_path&quot; and &quot;path_prefix&quot;.</p>
228
259
  </div>
229
260
  </div>
230
261
  </section>
231
262
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
232
- <a name="mutualTls" class="tsd-anchor"></a>
233
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> mutual<wbr>Tls</h3>
234
- <div class="tsd-signature tsd-kind-icon">mutual<wbr>Tls<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointMutualTLS.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLS</a></div>
263
+ <a name="metadata" class="tsd-anchor"></a>
264
+ <h3>metadata</h3>
265
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
235
266
  <aside class="tsd-sources">
236
267
  <ul>
237
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L262">datatypes.ts:262</a></li>
268
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L785">datatypes.ts:785</a></li>
238
269
  </ul>
239
270
  </aside>
240
271
  <div class="tsd-comment tsd-typography">
241
272
  <div class="lead">
242
- <p>mutual TLS module configuration or <code>null</code></p>
273
+ <p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
243
274
  </div>
244
275
  </div>
245
276
  </section>
@@ -249,7 +280,7 @@
249
280
  <div class="tsd-signature tsd-kind-icon">oauth<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuth</a></div>
250
281
  <aside class="tsd-sources">
251
282
  <ul>
252
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L268">datatypes.ts:268</a></li>
283
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L801">datatypes.ts:801</a></li>
253
284
  </ul>
254
285
  </aside>
255
286
  <div class="tsd-comment tsd-typography">
@@ -264,7 +295,7 @@
264
295
  <div class="tsd-signature tsd-kind-icon">oidc<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOIDC.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOIDC</a></div>
265
296
  <aside class="tsd-sources">
266
297
  <ul>
267
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L274">datatypes.ts:274</a></li>
298
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L805">datatypes.ts:805</a></li>
268
299
  </ul>
269
300
  </aside>
270
301
  <div class="tsd-comment tsd-typography">
@@ -279,7 +310,7 @@
279
310
  <div class="tsd-signature tsd-kind-icon">request<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointRequestHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointRequestHeaders</a></div>
280
311
  <aside class="tsd-sources">
281
312
  <ul>
282
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L256">datatypes.ts:256</a></li>
313
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L795">datatypes.ts:795</a></li>
283
314
  </ul>
284
315
  </aside>
285
316
  <div class="tsd-comment tsd-typography">
@@ -294,7 +325,7 @@
294
325
  <div class="tsd-signature tsd-kind-icon">response<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointResponseHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointResponseHeaders</a></div>
295
326
  <aside class="tsd-sources">
296
327
  <ul>
297
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L258">datatypes.ts:258</a></li>
328
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L797">datatypes.ts:797</a></li>
298
329
  </ul>
299
330
  </aside>
300
331
  <div class="tsd-comment tsd-typography">
@@ -309,7 +340,7 @@
309
340
  <div class="tsd-signature tsd-kind-icon">saml<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointSAML.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAML</a></div>
310
341
  <aside class="tsd-sources">
311
342
  <ul>
312
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L272">datatypes.ts:272</a></li>
343
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L803">datatypes.ts:803</a></li>
313
344
  </ul>
314
345
  </aside>
315
346
  <div class="tsd-comment tsd-typography">
@@ -319,62 +350,47 @@
319
350
  </div>
320
351
  </section>
321
352
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
322
- <a name="tlsTermination" class="tsd-anchor"></a>
323
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> tls<wbr>Termination</h3>
324
- <div class="tsd-signature tsd-kind-icon">tls<wbr>Termination<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</a></div>
325
- <aside class="tsd-sources">
326
- <ul>
327
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L264">datatypes.ts:264</a></li>
328
- </ul>
329
- </aside>
330
- <div class="tsd-comment tsd-typography">
331
- <div class="lead">
332
- <p>TLS termination module configuration or <code>null</code></p>
333
- </div>
334
- </div>
335
- </section>
336
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
337
- <a name="type" class="tsd-anchor"></a>
338
- <h3>type</h3>
339
- <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
353
+ <a name="uri" class="tsd-anchor"></a>
354
+ <h3>uri</h3>
355
+ <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
340
356
  <aside class="tsd-sources">
341
357
  <ul>
342
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L242">datatypes.ts:242</a></li>
358
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L781">datatypes.ts:781</a></li>
343
359
  </ul>
344
360
  </aside>
345
361
  <div class="tsd-comment tsd-typography">
346
362
  <div class="lead">
347
- <p>they type of traffic this endpoint configuration can be applied to. one of: <code>http</code>, <code>https</code>, <code>tcp</code></p>
363
+ <p>URI of the edge API resource</p>
348
364
  </div>
349
365
  </div>
350
366
  </section>
351
367
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
352
- <a name="uri" class="tsd-anchor"></a>
353
- <h3>uri</h3>
354
- <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
368
+ <a name="webhookVerification" class="tsd-anchor"></a>
369
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> webhook<wbr>Verification</h3>
370
+ <div class="tsd-signature tsd-kind-icon">webhook<wbr>Verification<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebhookValidation.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebhookValidation</a></div>
355
371
  <aside class="tsd-sources">
356
372
  <ul>
357
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L250">datatypes.ts:250</a></li>
373
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L799">datatypes.ts:799</a></li>
358
374
  </ul>
359
375
  </aside>
360
376
  <div class="tsd-comment tsd-typography">
361
377
  <div class="lead">
362
- <p>URI of the endpoint configuration API resource</p>
378
+ <p>webhook verification module configuration or <code>null</code></p>
363
379
  </div>
364
380
  </div>
365
381
  </section>
366
382
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
367
- <a name="webhookValidation" class="tsd-anchor"></a>
368
- <h3><span class="tsd-flag ts-flagOptional">Optional</span> webhook<wbr>Validation</h3>
369
- <div class="tsd-signature tsd-kind-icon">webhook<wbr>Validation<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebhookValidation.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebhookValidation</a></div>
383
+ <a name="websocketTcpConverter" class="tsd-anchor"></a>
384
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> websocket<wbr>Tcp<wbr>Converter</h3>
385
+ <div class="tsd-signature tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebsocketTCPConverter.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebsocketTCPConverter</a></div>
370
386
  <aside class="tsd-sources">
371
387
  <ul>
372
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L266">datatypes.ts:266</a></li>
388
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L807">datatypes.ts:807</a></li>
373
389
  </ul>
374
390
  </aside>
375
391
  <div class="tsd-comment tsd-typography">
376
392
  <div class="lead">
377
- <p>webhook validation module configuration or <code>null</code></p>
393
+ <p>websocket to tcp adapter configuration or <code>null</code></p>
378
394
  </div>
379
395
  </div>
380
396
  </section>
@@ -402,61 +418,64 @@
402
418
  </ul>
403
419
  <ul class="current">
404
420
  <li class="current tsd-kind-interface tsd-parent-kind-module">
405
- <a href="datatypes.EndpointConfiguration.html" class="tsd-kind-icon">Endpoint<wbr>Configuration</a>
421
+ <a href="datatypes.HTTPSEdgeRoute.html" class="tsd-kind-icon">HTTPSEdge<wbr>Route</a>
406
422
  <ul>
407
423
  <li class=" tsd-kind-property tsd-parent-kind-interface">
408
- <a href="datatypes.EndpointConfiguration.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a>
424
+ <a href="datatypes.HTTPSEdgeRoute.html#backend" class="tsd-kind-icon">backend</a>
425
+ </li>
426
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
427
+ <a href="datatypes.HTTPSEdgeRoute.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a>
409
428
  </li>
410
429
  <li class=" tsd-kind-property tsd-parent-kind-interface">
411
- <a href="datatypes.EndpointConfiguration.html#compression" class="tsd-kind-icon">compression</a>
430
+ <a href="datatypes.HTTPSEdgeRoute.html#compression" class="tsd-kind-icon">compression</a>
412
431
  </li>
413
432
  <li class=" tsd-kind-property tsd-parent-kind-interface">
414
- <a href="datatypes.EndpointConfiguration.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
433
+ <a href="datatypes.HTTPSEdgeRoute.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
415
434
  </li>
416
435
  <li class=" tsd-kind-property tsd-parent-kind-interface">
417
- <a href="datatypes.EndpointConfiguration.html#description" class="tsd-kind-icon">description</a>
436
+ <a href="datatypes.HTTPSEdgeRoute.html#description" class="tsd-kind-icon">description</a>
418
437
  </li>
419
438
  <li class=" tsd-kind-property tsd-parent-kind-interface">
420
- <a href="datatypes.EndpointConfiguration.html#id" class="tsd-kind-icon">id</a>
439
+ <a href="datatypes.HTTPSEdgeRoute.html#edgeId" class="tsd-kind-icon">edge<wbr>Id</a>
421
440
  </li>
422
441
  <li class=" tsd-kind-property tsd-parent-kind-interface">
423
- <a href="datatypes.EndpointConfiguration.html#ipPolicy" class="tsd-kind-icon">ip<wbr>Policy</a>
442
+ <a href="datatypes.HTTPSEdgeRoute.html#id" class="tsd-kind-icon">id</a>
424
443
  </li>
425
444
  <li class=" tsd-kind-property tsd-parent-kind-interface">
426
- <a href="datatypes.EndpointConfiguration.html#logging" class="tsd-kind-icon">logging</a>
445
+ <a href="datatypes.HTTPSEdgeRoute.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a>
427
446
  </li>
428
447
  <li class=" tsd-kind-property tsd-parent-kind-interface">
429
- <a href="datatypes.EndpointConfiguration.html#metadata" class="tsd-kind-icon">metadata</a>
448
+ <a href="datatypes.HTTPSEdgeRoute.html#match" class="tsd-kind-icon">match</a>
430
449
  </li>
431
450
  <li class=" tsd-kind-property tsd-parent-kind-interface">
432
- <a href="datatypes.EndpointConfiguration.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a>
451
+ <a href="datatypes.HTTPSEdgeRoute.html#matchType" class="tsd-kind-icon">match<wbr>Type</a>
433
452
  </li>
434
453
  <li class=" tsd-kind-property tsd-parent-kind-interface">
435
- <a href="datatypes.EndpointConfiguration.html#oauth" class="tsd-kind-icon">oauth</a>
454
+ <a href="datatypes.HTTPSEdgeRoute.html#metadata" class="tsd-kind-icon">metadata</a>
436
455
  </li>
437
456
  <li class=" tsd-kind-property tsd-parent-kind-interface">
438
- <a href="datatypes.EndpointConfiguration.html#oidc" class="tsd-kind-icon">oidc</a>
457
+ <a href="datatypes.HTTPSEdgeRoute.html#oauth" class="tsd-kind-icon">oauth</a>
439
458
  </li>
440
459
  <li class=" tsd-kind-property tsd-parent-kind-interface">
441
- <a href="datatypes.EndpointConfiguration.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a>
460
+ <a href="datatypes.HTTPSEdgeRoute.html#oidc" class="tsd-kind-icon">oidc</a>
442
461
  </li>
443
462
  <li class=" tsd-kind-property tsd-parent-kind-interface">
444
- <a href="datatypes.EndpointConfiguration.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a>
463
+ <a href="datatypes.HTTPSEdgeRoute.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a>
445
464
  </li>
446
465
  <li class=" tsd-kind-property tsd-parent-kind-interface">
447
- <a href="datatypes.EndpointConfiguration.html#saml" class="tsd-kind-icon">saml</a>
466
+ <a href="datatypes.HTTPSEdgeRoute.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a>
448
467
  </li>
449
468
  <li class=" tsd-kind-property tsd-parent-kind-interface">
450
- <a href="datatypes.EndpointConfiguration.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a>
469
+ <a href="datatypes.HTTPSEdgeRoute.html#saml" class="tsd-kind-icon">saml</a>
451
470
  </li>
452
471
  <li class=" tsd-kind-property tsd-parent-kind-interface">
453
- <a href="datatypes.EndpointConfiguration.html#type" class="tsd-kind-icon">type</a>
472
+ <a href="datatypes.HTTPSEdgeRoute.html#uri" class="tsd-kind-icon">uri</a>
454
473
  </li>
455
474
  <li class=" tsd-kind-property tsd-parent-kind-interface">
456
- <a href="datatypes.EndpointConfiguration.html#uri" class="tsd-kind-icon">uri</a>
475
+ <a href="datatypes.HTTPSEdgeRoute.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a>
457
476
  </li>
458
477
  <li class=" tsd-kind-property tsd-parent-kind-interface">
459
- <a href="datatypes.EndpointConfiguration.html#webhookValidation" class="tsd-kind-icon">webhook<wbr>Validation</a>
478
+ <a href="datatypes.HTTPSEdgeRoute.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</a>
460
479
  </li>
461
480
  </ul>
462
481
  </li>