@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
@@ -117,7 +117,7 @@
117
117
  <div class="tsd-signature tsd-kind-icon">certificate<wbr>Pem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
118
118
  <aside class="tsd-sources">
119
119
  <ul>
120
- <li>Defined in datatypes.ts:1470</li>
120
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1829">datatypes.ts:1829</a></li>
121
121
  </ul>
122
122
  </aside>
123
123
  <div class="tsd-comment tsd-typography">
@@ -132,7 +132,7 @@
132
132
  <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
133
133
  <aside class="tsd-sources">
134
134
  <ul>
135
- <li>Defined in datatypes.ts:1464</li>
135
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1823">datatypes.ts:1823</a></li>
136
136
  </ul>
137
137
  </aside>
138
138
  <div class="tsd-comment tsd-typography">
@@ -147,7 +147,7 @@
147
147
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
148
148
  <aside class="tsd-sources">
149
149
  <ul>
150
- <li>Defined in datatypes.ts:1466</li>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1825">datatypes.ts:1825</a></li>
151
151
  </ul>
152
152
  </aside>
153
153
  <div class="tsd-comment tsd-typography">
@@ -162,7 +162,7 @@
162
162
  <div class="tsd-signature tsd-kind-icon">extended<wbr>Key<wbr>Usages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
163
163
  <aside class="tsd-sources">
164
164
  <ul>
165
- <li>Defined in datatypes.ts:1484</li>
165
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1843">datatypes.ts:1843</a></li>
166
166
  </ul>
167
167
  </aside>
168
168
  <div class="tsd-comment tsd-typography">
@@ -177,7 +177,7 @@
177
177
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
178
178
  <aside class="tsd-sources">
179
179
  <ul>
180
- <li>Defined in datatypes.ts:1460</li>
180
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1819">datatypes.ts:1819</a></li>
181
181
  </ul>
182
182
  </aside>
183
183
  <div class="tsd-comment tsd-typography">
@@ -192,7 +192,7 @@
192
192
  <div class="tsd-signature tsd-kind-icon">issued<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
193
193
  <aside class="tsd-sources">
194
194
  <ul>
195
- <li>Defined in datatypes.ts:1476</li>
195
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1835">datatypes.ts:1835</a></li>
196
196
  </ul>
197
197
  </aside>
198
198
  <div class="tsd-comment tsd-typography">
@@ -207,7 +207,7 @@
207
207
  <div class="tsd-signature tsd-kind-icon">issuer<wbr>Common<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
208
208
  <aside class="tsd-sources">
209
209
  <ul>
210
- <li>Defined in datatypes.ts:1488</li>
210
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1847">datatypes.ts:1847</a></li>
211
211
  </ul>
212
212
  </aside>
213
213
  <div class="tsd-comment tsd-typography">
@@ -222,7 +222,7 @@
222
222
  <div class="tsd-signature tsd-kind-icon">key<wbr>Usages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
223
223
  <aside class="tsd-sources">
224
224
  <ul>
225
- <li>Defined in datatypes.ts:1482</li>
225
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1841">datatypes.ts:1841</a></li>
226
226
  </ul>
227
227
  </aside>
228
228
  <div class="tsd-comment tsd-typography">
@@ -237,7 +237,7 @@
237
237
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
238
238
  <aside class="tsd-sources">
239
239
  <ul>
240
- <li>Defined in datatypes.ts:1468</li>
240
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1827">datatypes.ts:1827</a></li>
241
241
  </ul>
242
242
  </aside>
243
243
  <div class="tsd-comment tsd-typography">
@@ -252,7 +252,7 @@
252
252
  <div class="tsd-signature tsd-kind-icon">not<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
253
253
  <aside class="tsd-sources">
254
254
  <ul>
255
- <li>Defined in datatypes.ts:1480</li>
255
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1839">datatypes.ts:1839</a></li>
256
256
  </ul>
257
257
  </aside>
258
258
  <div class="tsd-comment tsd-typography">
@@ -267,7 +267,7 @@
267
267
  <div class="tsd-signature tsd-kind-icon">not<wbr>Before<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
268
268
  <aside class="tsd-sources">
269
269
  <ul>
270
- <li>Defined in datatypes.ts:1478</li>
270
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1837">datatypes.ts:1837</a></li>
271
271
  </ul>
272
272
  </aside>
273
273
  <div class="tsd-comment tsd-typography">
@@ -282,7 +282,7 @@
282
282
  <div class="tsd-signature tsd-kind-icon">private<wbr>Key<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
283
283
  <aside class="tsd-sources">
284
284
  <ul>
285
- <li>Defined in datatypes.ts:1486</li>
285
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1845">datatypes.ts:1845</a></li>
286
286
  </ul>
287
287
  </aside>
288
288
  <div class="tsd-comment tsd-typography">
@@ -297,7 +297,7 @@
297
297
  <div class="tsd-signature tsd-kind-icon">serial<wbr>Number<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
298
298
  <aside class="tsd-sources">
299
299
  <ul>
300
- <li>Defined in datatypes.ts:1490</li>
300
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1849">datatypes.ts:1849</a></li>
301
301
  </ul>
302
302
  </aside>
303
303
  <div class="tsd-comment tsd-typography">
@@ -312,7 +312,7 @@
312
312
  <div class="tsd-signature tsd-kind-icon">subject<wbr>Alternative<wbr>Names<span class="tsd-signature-symbol">:</span> <a href="datatypes.TLSCertificateSANs.html" class="tsd-signature-type" data-tsd-kind="Interface">TLSCertificateSANs</a></div>
313
313
  <aside class="tsd-sources">
314
314
  <ul>
315
- <li>Defined in datatypes.ts:1474</li>
315
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1833">datatypes.ts:1833</a></li>
316
316
  </ul>
317
317
  </aside>
318
318
  <div class="tsd-comment tsd-typography">
@@ -327,7 +327,7 @@
327
327
  <div class="tsd-signature tsd-kind-icon">subject<wbr>Common<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
328
328
  <aside class="tsd-sources">
329
329
  <ul>
330
- <li>Defined in datatypes.ts:1472</li>
330
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1831">datatypes.ts:1831</a></li>
331
331
  </ul>
332
332
  </aside>
333
333
  <div class="tsd-comment tsd-typography">
@@ -342,7 +342,7 @@
342
342
  <div class="tsd-signature tsd-kind-icon">subject<wbr>Country<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
343
343
  <aside class="tsd-sources">
344
344
  <ul>
345
- <li>Defined in datatypes.ts:1500</li>
345
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1859">datatypes.ts:1859</a></li>
346
346
  </ul>
347
347
  </aside>
348
348
  <div class="tsd-comment tsd-typography">
@@ -357,7 +357,7 @@
357
357
  <div class="tsd-signature tsd-kind-icon">subject<wbr>Locality<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
358
358
  <aside class="tsd-sources">
359
359
  <ul>
360
- <li>Defined in datatypes.ts:1496</li>
360
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1855">datatypes.ts:1855</a></li>
361
361
  </ul>
362
362
  </aside>
363
363
  <div class="tsd-comment tsd-typography">
@@ -372,7 +372,7 @@
372
372
  <div class="tsd-signature tsd-kind-icon">subject<wbr>Organization<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
373
373
  <aside class="tsd-sources">
374
374
  <ul>
375
- <li>Defined in datatypes.ts:1492</li>
375
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1851">datatypes.ts:1851</a></li>
376
376
  </ul>
377
377
  </aside>
378
378
  <div class="tsd-comment tsd-typography">
@@ -387,7 +387,7 @@
387
387
  <div class="tsd-signature tsd-kind-icon">subject<wbr>Organizational<wbr>Unit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
388
388
  <aside class="tsd-sources">
389
389
  <ul>
390
- <li>Defined in datatypes.ts:1494</li>
390
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1853">datatypes.ts:1853</a></li>
391
391
  </ul>
392
392
  </aside>
393
393
  <div class="tsd-comment tsd-typography">
@@ -402,7 +402,7 @@
402
402
  <div class="tsd-signature tsd-kind-icon">subject<wbr>Province<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
403
403
  <aside class="tsd-sources">
404
404
  <ul>
405
- <li>Defined in datatypes.ts:1498</li>
405
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1857">datatypes.ts:1857</a></li>
406
406
  </ul>
407
407
  </aside>
408
408
  <div class="tsd-comment tsd-typography">
@@ -417,7 +417,7 @@
417
417
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
418
418
  <aside class="tsd-sources">
419
419
  <ul>
420
- <li>Defined in datatypes.ts:1462</li>
420
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1821">datatypes.ts:1821</a></li>
421
421
  </ul>
422
422
  </aside>
423
423
  <div class="tsd-comment tsd-typography">
@@ -100,7 +100,7 @@
100
100
  <div class="tsd-signature tsd-kind-icon">certificate<wbr>Pem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
101
101
  <aside class="tsd-sources">
102
102
  <ul>
103
- <li>Defined in datatypes.ts:1445</li>
103
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1804">datatypes.ts:1804</a></li>
104
104
  </ul>
105
105
  </aside>
106
106
  <div class="tsd-comment tsd-typography">
@@ -115,7 +115,7 @@
115
115
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
116
116
  <aside class="tsd-sources">
117
117
  <ul>
118
- <li>Defined in datatypes.ts:1441</li>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1800">datatypes.ts:1800</a></li>
119
119
  </ul>
120
120
  </aside>
121
121
  <div class="tsd-comment tsd-typography">
@@ -130,7 +130,7 @@
130
130
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
131
131
  <aside class="tsd-sources">
132
132
  <ul>
133
- <li>Defined in datatypes.ts:1443</li>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1802">datatypes.ts:1802</a></li>
134
134
  </ul>
135
135
  </aside>
136
136
  <div class="tsd-comment tsd-typography">
@@ -145,7 +145,7 @@
145
145
  <div class="tsd-signature tsd-kind-icon">private<wbr>Key<wbr>Pem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
146
146
  <aside class="tsd-sources">
147
147
  <ul>
148
- <li>Defined in datatypes.ts:1447</li>
148
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1806">datatypes.ts:1806</a></li>
149
149
  </ul>
150
150
  </aside>
151
151
  <div class="tsd-comment tsd-typography">
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
100
  <aside class="tsd-sources">
101
101
  <ul>
102
- <li>Defined in datatypes.ts:1509</li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1868">datatypes.ts:1868</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  <div class="tsd-comment tsd-typography">
@@ -114,7 +114,7 @@
114
114
  <div class="tsd-signature tsd-kind-icon">tls<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="datatypes.TLSCertificate.html" class="tsd-signature-type" data-tsd-kind="Interface">TLSCertificate</a><span class="tsd-signature-symbol">[]</span></div>
115
115
  <aside class="tsd-sources">
116
116
  <ul>
117
- <li>Defined in datatypes.ts:1505</li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1864">datatypes.ts:1864</a></li>
118
118
  </ul>
119
119
  </aside>
120
120
  <div class="tsd-comment tsd-typography">
@@ -129,7 +129,7 @@
129
129
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130
130
  <aside class="tsd-sources">
131
131
  <ul>
132
- <li>Defined in datatypes.ts:1507</li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1866">datatypes.ts:1866</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <div class="tsd-comment tsd-typography">
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">dns<wbr>Names<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in datatypes.ts:1514</li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1873">datatypes.ts:1873</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  <div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
113
113
  <div class="tsd-signature tsd-kind-icon">ips<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
114
114
  <aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in datatypes.ts:1516</li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1875">datatypes.ts:1875</a></li>
117
117
  </ul>
118
118
  </aside>
119
119
  <div class="tsd-comment tsd-typography">
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
100
  <aside class="tsd-sources">
101
101
  <ul>
102
- <li>Defined in datatypes.ts:1453</li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1812">datatypes.ts:1812</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  <div class="tsd-comment tsd-typography">
@@ -114,7 +114,7 @@
114
114
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
115
115
  <aside class="tsd-sources">
116
116
  <ul>
117
- <li>Defined in datatypes.ts:1451</li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1810">datatypes.ts:1810</a></li>
118
118
  </ul>
119
119
  </aside>
120
120
  </section>
@@ -124,7 +124,7 @@
124
124
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
125
125
  <aside class="tsd-sources">
126
126
  <ul>
127
- <li>Defined in datatypes.ts:1455</li>
127
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1814">datatypes.ts:1814</a></li>
128
128
  </ul>
129
129
  </aside>
130
130
  <div class="tsd-comment tsd-typography">
@@ -0,0 +1,323 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>TLSEdge | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.TLSEdge.html">TLSEdge</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface TLSEdge</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">TLSEdge</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#backend" class="tsd-kind-icon">backend</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#description" class="tsd-kind-icon">description</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#hostports" class="tsd-kind-icon">hostports</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#id" class="tsd-kind-icon">id</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#metadata" class="tsd-kind-icon">metadata</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#uri" class="tsd-kind-icon">uri</a></li>
96
+ </ul>
97
+ </section>
98
+ </div>
99
+ </section>
100
+ </section>
101
+ <section class="tsd-panel-group tsd-member-group ">
102
+ <h2>Properties</h2>
103
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
104
+ <a name="backend" class="tsd-anchor"></a>
105
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> backend</h3>
106
+ <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>
107
+ <aside class="tsd-sources">
108
+ <ul>
109
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1062">datatypes.ts:1062</a></li>
110
+ </ul>
111
+ </aside>
112
+ <div class="tsd-comment tsd-typography">
113
+ <div class="lead">
114
+ <p>edge modules</p>
115
+ </div>
116
+ </div>
117
+ </section>
118
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
119
+ <a name="createdAt" class="tsd-anchor"></a>
120
+ <h3>created<wbr>At</h3>
121
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
122
+ <aside class="tsd-sources">
123
+ <ul>
124
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1056">datatypes.ts:1056</a></li>
125
+ </ul>
126
+ </aside>
127
+ <div class="tsd-comment tsd-typography">
128
+ <div class="lead">
129
+ <p>timestamp when the edge configuration was created, RFC 3339 format</p>
130
+ </div>
131
+ </div>
132
+ </section>
133
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
134
+ <a name="description" class="tsd-anchor"></a>
135
+ <h3>description</h3>
136
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
137
+ <aside class="tsd-sources">
138
+ <ul>
139
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1052">datatypes.ts:1052</a></li>
140
+ </ul>
141
+ </aside>
142
+ <div class="tsd-comment tsd-typography">
143
+ <div class="lead">
144
+ <p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
145
+ </div>
146
+ </div>
147
+ </section>
148
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
149
+ <a name="hostports" class="tsd-anchor"></a>
150
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> hostports</h3>
151
+ <div class="tsd-signature tsd-kind-icon">hostports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
152
+ <aside class="tsd-sources">
153
+ <ul>
154
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1060">datatypes.ts:1060</a></li>
155
+ </ul>
156
+ </aside>
157
+ <div class="tsd-comment tsd-typography">
158
+ <div class="lead">
159
+ <p>hostports served by this edge</p>
160
+ </div>
161
+ </div>
162
+ </section>
163
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
164
+ <a name="id" class="tsd-anchor"></a>
165
+ <h3>id</h3>
166
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
167
+ <aside class="tsd-sources">
168
+ <ul>
169
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1050">datatypes.ts:1050</a></li>
170
+ </ul>
171
+ </aside>
172
+ <div class="tsd-comment tsd-typography">
173
+ <div class="lead">
174
+ <p>unique identifier of this edge</p>
175
+ </div>
176
+ </div>
177
+ </section>
178
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
179
+ <a name="ipRestriction" class="tsd-anchor"></a>
180
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ip<wbr>Restriction</h3>
181
+ <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>
182
+ <aside class="tsd-sources">
183
+ <ul>
184
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1063">datatypes.ts:1063</a></li>
185
+ </ul>
186
+ </aside>
187
+ </section>
188
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
189
+ <a name="metadata" class="tsd-anchor"></a>
190
+ <h3>metadata</h3>
191
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
192
+ <aside class="tsd-sources">
193
+ <ul>
194
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1054">datatypes.ts:1054</a></li>
195
+ </ul>
196
+ </aside>
197
+ <div class="tsd-comment tsd-typography">
198
+ <div class="lead">
199
+ <p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
200
+ </div>
201
+ </div>
202
+ </section>
203
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
204
+ <a name="mutualTls" class="tsd-anchor"></a>
205
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> mutual<wbr>Tls</h3>
206
+ <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>
207
+ <aside class="tsd-sources">
208
+ <ul>
209
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1064">datatypes.ts:1064</a></li>
210
+ </ul>
211
+ </aside>
212
+ </section>
213
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
214
+ <a name="tlsTermination" class="tsd-anchor"></a>
215
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> tls<wbr>Termination</h3>
216
+ <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>
217
+ <aside class="tsd-sources">
218
+ <ul>
219
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1065">datatypes.ts:1065</a></li>
220
+ </ul>
221
+ </aside>
222
+ </section>
223
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
224
+ <a name="uri" class="tsd-anchor"></a>
225
+ <h3>uri</h3>
226
+ <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
227
+ <aside class="tsd-sources">
228
+ <ul>
229
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1058">datatypes.ts:1058</a></li>
230
+ </ul>
231
+ </aside>
232
+ <div class="tsd-comment tsd-typography">
233
+ <div class="lead">
234
+ <p>URI of the edge API resource</p>
235
+ </div>
236
+ </div>
237
+ </section>
238
+ </section>
239
+ </div>
240
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
241
+ <nav class="tsd-navigation primary">
242
+ <ul>
243
+ <li class=" ">
244
+ <a href="../modules.html">Modules</a>
245
+ </li>
246
+ <li class=" tsd-kind-module">
247
+ <a href="../modules/client.html">client</a>
248
+ </li>
249
+ <li class="current tsd-kind-module">
250
+ <a href="../modules/datatypes.html">datatypes</a>
251
+ </li>
252
+ <li class=" tsd-kind-module">
253
+ <a href="../modules/services.html">services</a>
254
+ </li>
255
+ </ul>
256
+ </nav>
257
+ <nav class="tsd-navigation secondary menu-sticky">
258
+ <ul class="before-current">
259
+ </ul>
260
+ <ul class="current">
261
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
262
+ <a href="datatypes.TLSEdge.html" class="tsd-kind-icon">TLSEdge</a>
263
+ <ul>
264
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
265
+ <a href="datatypes.TLSEdge.html#backend" class="tsd-kind-icon">backend</a>
266
+ </li>
267
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
268
+ <a href="datatypes.TLSEdge.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
269
+ </li>
270
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
271
+ <a href="datatypes.TLSEdge.html#description" class="tsd-kind-icon">description</a>
272
+ </li>
273
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
274
+ <a href="datatypes.TLSEdge.html#hostports" class="tsd-kind-icon">hostports</a>
275
+ </li>
276
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
277
+ <a href="datatypes.TLSEdge.html#id" class="tsd-kind-icon">id</a>
278
+ </li>
279
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
280
+ <a href="datatypes.TLSEdge.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a>
281
+ </li>
282
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
283
+ <a href="datatypes.TLSEdge.html#metadata" class="tsd-kind-icon">metadata</a>
284
+ </li>
285
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
286
+ <a href="datatypes.TLSEdge.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a>
287
+ </li>
288
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
289
+ <a href="datatypes.TLSEdge.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a>
290
+ </li>
291
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
292
+ <a href="datatypes.TLSEdge.html#uri" class="tsd-kind-icon">uri</a>
293
+ </li>
294
+ </ul>
295
+ </li>
296
+ </ul>
297
+ <ul class="after-current">
298
+ </ul>
299
+ </nav>
300
+ </div>
301
+ </div>
302
+ </div>
303
+ <footer class="with-border-bottom">
304
+ <div class="container">
305
+ <h2>Legend</h2>
306
+ <div class="tsd-legend-group">
307
+ <ul class="tsd-legend">
308
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
309
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
310
+ </ul>
311
+ <ul class="tsd-legend">
312
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
313
+ </ul>
314
+ </div>
315
+ </div>
316
+ </footer>
317
+ <div class="container tsd-generator">
318
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
319
+ </div>
320
+ <div class="overlay"></div>
321
+ <script src="../assets/js/main.js"></script>
322
+ </body>
323
+ </html>