@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
@@ -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>HTTPSEdgeRouteUpdate | @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.HTTPSEdgeRouteUpdate.html">HTTPSEdgeRouteUpdate</a>
62
62
  </li>
63
63
  </ul>
64
- <h1>Interface EndpointConfiguration</h1>
64
+ <h1>Interface HTTPSEdgeRouteUpdate</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">HTTPSEdgeRouteUpdate</span>
76
76
  </li>
77
77
  </ul>
78
78
  </section>
@@ -83,24 +83,23 @@
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.HTTPSEdgeRouteUpdate.html#backend" class="tsd-kind-icon">backend</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#compression" class="tsd-kind-icon">compression</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#description" class="tsd-kind-icon">description</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#edgeId" class="tsd-kind-icon">edge<wbr>Id</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#id" class="tsd-kind-icon">id</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#match" class="tsd-kind-icon">match</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#matchType" class="tsd-kind-icon">match<wbr>Type</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#oauth" class="tsd-kind-icon">oauth</a></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#oidc" class="tsd-kind-icon">oidc</a></li>
98
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a></li>
99
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a></li>
100
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#saml" class="tsd-kind-icon">saml</a></li>
101
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a></li>
102
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</a></li>
104
103
  </ul>
105
104
  </section>
106
105
  </div>
@@ -108,13 +107,28 @@
108
107
  </section>
109
108
  <section class="tsd-panel-group tsd-member-group ">
110
109
  <h2>Properties</h2>
110
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
111
+ <a name="backend" class="tsd-anchor"></a>
112
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> backend</h3>
113
+ <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>
114
+ <aside class="tsd-sources">
115
+ <ul>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L746">datatypes.ts:746</a></li>
117
+ </ul>
118
+ </aside>
119
+ <div class="tsd-comment tsd-typography">
120
+ <div class="lead">
121
+ <p>backend module configuration or <code>null</code></p>
122
+ </div>
123
+ </div>
124
+ </section>
111
125
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
112
126
  <a name="circuitBreaker" class="tsd-anchor"></a>
113
127
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> circuit<wbr>Breaker</h3>
114
128
  <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
129
  <aside class="tsd-sources">
116
130
  <ul>
117
- <li>Defined in datatypes.ts:207</li>
131
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L750">datatypes.ts:750</a></li>
118
132
  </ul>
119
133
  </aside>
120
134
  <div class="tsd-comment tsd-typography">
@@ -129,7 +143,7 @@
129
143
  <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
144
  <aside class="tsd-sources">
131
145
  <ul>
132
- <li>Defined in datatypes.ts:209</li>
146
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L752">datatypes.ts:752</a></li>
133
147
  </ul>
134
148
  </aside>
135
149
  <div class="tsd-comment tsd-typography">
@@ -139,32 +153,32 @@
139
153
  </div>
140
154
  </section>
141
155
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
142
- <a name="createdAt" class="tsd-anchor"></a>
143
- <h3>created<wbr>At</h3>
144
- <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
156
+ <a name="description" class="tsd-anchor"></a>
157
+ <h3>description</h3>
158
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
145
159
  <aside class="tsd-sources">
146
160
  <ul>
147
- <li>Defined in datatypes.ts:203</li>
161
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L742">datatypes.ts:742</a></li>
148
162
  </ul>
149
163
  </aside>
150
164
  <div class="tsd-comment tsd-typography">
151
165
  <div class="lead">
152
- <p>timestamp when the endpoint configuration was created, RFC 3339 format</p>
166
+ <p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
153
167
  </div>
154
168
  </div>
155
169
  </section>
156
170
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
157
- <a name="description" class="tsd-anchor"></a>
158
- <h3>description</h3>
159
- <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
171
+ <a name="edgeId" class="tsd-anchor"></a>
172
+ <h3>edge<wbr>Id</h3>
173
+ <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
160
174
  <aside class="tsd-sources">
161
175
  <ul>
162
- <li>Defined in datatypes.ts:199</li>
176
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L734">datatypes.ts:734</a></li>
163
177
  </ul>
164
178
  </aside>
165
179
  <div class="tsd-comment tsd-typography">
166
180
  <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>
181
+ <p>unique identifier of this edge</p>
168
182
  </div>
169
183
  </div>
170
184
  </section>
@@ -174,72 +188,72 @@
174
188
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
175
189
  <aside class="tsd-sources">
176
190
  <ul>
177
- <li>Defined in datatypes.ts:195</li>
191
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L736">datatypes.ts:736</a></li>
178
192
  </ul>
179
193
  </aside>
180
194
  <div class="tsd-comment tsd-typography">
181
195
  <div class="lead">
182
- <p>unique identifier of this endpoint configuration</p>
196
+ <p>unique identifier of this edge route</p>
183
197
  </div>
184
198
  </div>
185
199
  </section>
186
200
  <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>
201
+ <a name="ipRestriction" class="tsd-anchor"></a>
202
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip<wbr>Restriction</h3>
203
+ <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>
190
204
  <aside class="tsd-sources">
191
205
  <ul>
192
- <li>Defined in datatypes.ts:215</li>
206
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L748">datatypes.ts:748</a></li>
193
207
  </ul>
194
208
  </aside>
195
209
  <div class="tsd-comment tsd-typography">
196
210
  <div class="lead">
197
- <p>ip policy module configuration or <code>null</code></p>
211
+ <p>ip restriction module configuration or <code>null</code></p>
198
212
  </div>
199
213
  </div>
200
214
  </section>
201
215
  <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>
216
+ <a name="match" class="tsd-anchor"></a>
217
+ <h3>match</h3>
218
+ <div class="tsd-signature tsd-kind-icon">match<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
205
219
  <aside class="tsd-sources">
206
220
  <ul>
207
- <li>Defined in datatypes.ts:225</li>
221
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L740">datatypes.ts:740</a></li>
208
222
  </ul>
209
223
  </aside>
210
224
  <div class="tsd-comment tsd-typography">
211
225
  <div class="lead">
212
- <p>logging module configuration or <code>null</code></p>
226
+ <p>Route selector: &quot;/blog&quot; or &quot;example.com&quot; or &quot;example.com/blog&quot;</p>
213
227
  </div>
214
228
  </div>
215
229
  </section>
216
230
  <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>
231
+ <a name="matchType" class="tsd-anchor"></a>
232
+ <h3>match<wbr>Type</h3>
233
+ <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
234
  <aside class="tsd-sources">
221
235
  <ul>
222
- <li>Defined in datatypes.ts:201</li>
236
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L738">datatypes.ts:738</a></li>
223
237
  </ul>
224
238
  </aside>
225
239
  <div class="tsd-comment tsd-typography">
226
240
  <div class="lead">
227
- <p>arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p>
241
+ <p>Type of match to use for this route. Valid values are &quot;exact_path&quot; and &quot;path_prefix&quot;.</p>
228
242
  </div>
229
243
  </div>
230
244
  </section>
231
245
  <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>
246
+ <a name="metadata" class="tsd-anchor"></a>
247
+ <h3>metadata</h3>
248
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
235
249
  <aside class="tsd-sources">
236
250
  <ul>
237
- <li>Defined in datatypes.ts:217</li>
251
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L744">datatypes.ts:744</a></li>
238
252
  </ul>
239
253
  </aside>
240
254
  <div class="tsd-comment tsd-typography">
241
255
  <div class="lead">
242
- <p>mutual TLS module configuration or <code>null</code></p>
256
+ <p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
243
257
  </div>
244
258
  </div>
245
259
  </section>
@@ -249,7 +263,7 @@
249
263
  <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
264
  <aside class="tsd-sources">
251
265
  <ul>
252
- <li>Defined in datatypes.ts:223</li>
266
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L760">datatypes.ts:760</a></li>
253
267
  </ul>
254
268
  </aside>
255
269
  <div class="tsd-comment tsd-typography">
@@ -264,7 +278,7 @@
264
278
  <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
279
  <aside class="tsd-sources">
266
280
  <ul>
267
- <li>Defined in datatypes.ts:229</li>
281
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L764">datatypes.ts:764</a></li>
268
282
  </ul>
269
283
  </aside>
270
284
  <div class="tsd-comment tsd-typography">
@@ -279,7 +293,7 @@
279
293
  <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
294
  <aside class="tsd-sources">
281
295
  <ul>
282
- <li>Defined in datatypes.ts:211</li>
296
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L754">datatypes.ts:754</a></li>
283
297
  </ul>
284
298
  </aside>
285
299
  <div class="tsd-comment tsd-typography">
@@ -294,7 +308,7 @@
294
308
  <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
309
  <aside class="tsd-sources">
296
310
  <ul>
297
- <li>Defined in datatypes.ts:213</li>
311
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L756">datatypes.ts:756</a></li>
298
312
  </ul>
299
313
  </aside>
300
314
  <div class="tsd-comment tsd-typography">
@@ -306,10 +320,10 @@
306
320
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
307
321
  <a name="saml" class="tsd-anchor"></a>
308
322
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> saml</h3>
309
- <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>
323
+ <div class="tsd-signature tsd-kind-icon">saml<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointSAMLMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAMLMutate</a></div>
310
324
  <aside class="tsd-sources">
311
325
  <ul>
312
- <li>Defined in datatypes.ts:227</li>
326
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L762">datatypes.ts:762</a></li>
313
327
  </ul>
314
328
  </aside>
315
329
  <div class="tsd-comment tsd-typography">
@@ -319,62 +333,32 @@
319
333
  </div>
320
334
  </section>
321
335
  <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>
336
+ <a name="webhookVerification" class="tsd-anchor"></a>
337
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> webhook<wbr>Verification</h3>
338
+ <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>
325
339
  <aside class="tsd-sources">
326
340
  <ul>
327
- <li>Defined in datatypes.ts:219</li>
341
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L758">datatypes.ts:758</a></li>
328
342
  </ul>
329
343
  </aside>
330
344
  <div class="tsd-comment tsd-typography">
331
345
  <div class="lead">
332
- <p>TLS termination module configuration or <code>null</code></p>
346
+ <p>webhook verification module configuration or <code>null</code></p>
333
347
  </div>
334
348
  </div>
335
349
  </section>
336
350
  <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>
351
+ <a name="websocketTcpConverter" class="tsd-anchor"></a>
352
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> websocket<wbr>Tcp<wbr>Converter</h3>
353
+ <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>
340
354
  <aside class="tsd-sources">
341
355
  <ul>
342
- <li>Defined in datatypes.ts:197</li>
356
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L766">datatypes.ts:766</a></li>
343
357
  </ul>
344
358
  </aside>
345
359
  <div class="tsd-comment tsd-typography">
346
360
  <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>
348
- </div>
349
- </div>
350
- </section>
351
- <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>
355
- <aside class="tsd-sources">
356
- <ul>
357
- <li>Defined in datatypes.ts:205</li>
358
- </ul>
359
- </aside>
360
- <div class="tsd-comment tsd-typography">
361
- <div class="lead">
362
- <p>URI of the endpoint configuration API resource</p>
363
- </div>
364
- </div>
365
- </section>
366
- <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>
370
- <aside class="tsd-sources">
371
- <ul>
372
- <li>Defined in datatypes.ts:221</li>
373
- </ul>
374
- </aside>
375
- <div class="tsd-comment tsd-typography">
376
- <div class="lead">
377
- <p>webhook validation module configuration or <code>null</code></p>
361
+ <p>websocket to tcp adapter configuration or <code>null</code></p>
378
362
  </div>
379
363
  </div>
380
364
  </section>
@@ -402,61 +386,58 @@
402
386
  </ul>
403
387
  <ul class="current">
404
388
  <li class="current tsd-kind-interface tsd-parent-kind-module">
405
- <a href="datatypes.EndpointConfiguration.html" class="tsd-kind-icon">Endpoint<wbr>Configuration</a>
389
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html" class="tsd-kind-icon">HTTPSEdge<wbr>Route<wbr>Update</a>
406
390
  <ul>
407
391
  <li class=" tsd-kind-property tsd-parent-kind-interface">
408
- <a href="datatypes.EndpointConfiguration.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a>
409
- </li>
410
- <li class=" tsd-kind-property tsd-parent-kind-interface">
411
- <a href="datatypes.EndpointConfiguration.html#compression" class="tsd-kind-icon">compression</a>
392
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#backend" class="tsd-kind-icon">backend</a>
412
393
  </li>
413
394
  <li class=" tsd-kind-property tsd-parent-kind-interface">
414
- <a href="datatypes.EndpointConfiguration.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
395
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#circuitBreaker" class="tsd-kind-icon">circuit<wbr>Breaker</a>
415
396
  </li>
416
397
  <li class=" tsd-kind-property tsd-parent-kind-interface">
417
- <a href="datatypes.EndpointConfiguration.html#description" class="tsd-kind-icon">description</a>
398
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#compression" class="tsd-kind-icon">compression</a>
418
399
  </li>
419
400
  <li class=" tsd-kind-property tsd-parent-kind-interface">
420
- <a href="datatypes.EndpointConfiguration.html#id" class="tsd-kind-icon">id</a>
401
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#description" class="tsd-kind-icon">description</a>
421
402
  </li>
422
403
  <li class=" tsd-kind-property tsd-parent-kind-interface">
423
- <a href="datatypes.EndpointConfiguration.html#ipPolicy" class="tsd-kind-icon">ip<wbr>Policy</a>
404
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#edgeId" class="tsd-kind-icon">edge<wbr>Id</a>
424
405
  </li>
425
406
  <li class=" tsd-kind-property tsd-parent-kind-interface">
426
- <a href="datatypes.EndpointConfiguration.html#logging" class="tsd-kind-icon">logging</a>
407
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#id" class="tsd-kind-icon">id</a>
427
408
  </li>
428
409
  <li class=" tsd-kind-property tsd-parent-kind-interface">
429
- <a href="datatypes.EndpointConfiguration.html#metadata" class="tsd-kind-icon">metadata</a>
410
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a>
430
411
  </li>
431
412
  <li class=" tsd-kind-property tsd-parent-kind-interface">
432
- <a href="datatypes.EndpointConfiguration.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a>
413
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#match" class="tsd-kind-icon">match</a>
433
414
  </li>
434
415
  <li class=" tsd-kind-property tsd-parent-kind-interface">
435
- <a href="datatypes.EndpointConfiguration.html#oauth" class="tsd-kind-icon">oauth</a>
416
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#matchType" class="tsd-kind-icon">match<wbr>Type</a>
436
417
  </li>
437
418
  <li class=" tsd-kind-property tsd-parent-kind-interface">
438
- <a href="datatypes.EndpointConfiguration.html#oidc" class="tsd-kind-icon">oidc</a>
419
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#metadata" class="tsd-kind-icon">metadata</a>
439
420
  </li>
440
421
  <li class=" tsd-kind-property tsd-parent-kind-interface">
441
- <a href="datatypes.EndpointConfiguration.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a>
422
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#oauth" class="tsd-kind-icon">oauth</a>
442
423
  </li>
443
424
  <li class=" tsd-kind-property tsd-parent-kind-interface">
444
- <a href="datatypes.EndpointConfiguration.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a>
425
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#oidc" class="tsd-kind-icon">oidc</a>
445
426
  </li>
446
427
  <li class=" tsd-kind-property tsd-parent-kind-interface">
447
- <a href="datatypes.EndpointConfiguration.html#saml" class="tsd-kind-icon">saml</a>
428
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a>
448
429
  </li>
449
430
  <li class=" tsd-kind-property tsd-parent-kind-interface">
450
- <a href="datatypes.EndpointConfiguration.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a>
431
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a>
451
432
  </li>
452
433
  <li class=" tsd-kind-property tsd-parent-kind-interface">
453
- <a href="datatypes.EndpointConfiguration.html#type" class="tsd-kind-icon">type</a>
434
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#saml" class="tsd-kind-icon">saml</a>
454
435
  </li>
455
436
  <li class=" tsd-kind-property tsd-parent-kind-interface">
456
- <a href="datatypes.EndpointConfiguration.html#uri" class="tsd-kind-icon">uri</a>
437
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a>
457
438
  </li>
458
439
  <li class=" tsd-kind-property tsd-parent-kind-interface">
459
- <a href="datatypes.EndpointConfiguration.html#webhookValidation" class="tsd-kind-icon">webhook<wbr>Validation</a>
440
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</a>
460
441
  </li>
461
442
  </ul>
462
443
  </li>