@ngrok/ngrok-api 0.9.0 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintignore +2 -0
- package/.eslintrc.js +2 -0
- package/.prettierrc.js +2 -0
- package/CHANGELOG.md +12 -3
- package/CODE_OF_CONDUCT.md +45 -0
- package/README.md +9 -3
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +54 -26
- package/docs/classes/services.APIKeys.html +20 -11
- package/docs/classes/services.AbuseReports.html +5 -5
- package/docs/classes/services.AgentIngresses.html +20 -11
- package/docs/classes/services.ApplicationSessions.html +288 -0
- package/docs/classes/services.ApplicationUsers.html +288 -0
- package/docs/classes/services.CertificateAuthorities.html +20 -11
- package/docs/classes/services.Credentials.html +21 -12
- package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
- package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
- package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
- package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
- package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
- package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
- package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
- package/docs/classes/services.EdgesHTTPS.html +20 -11
- package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
- package/docs/classes/services.EdgesTCP.html +20 -11
- package/docs/classes/services.EdgesTLS.html +20 -11
- package/docs/classes/services.Endpoints.html +15 -6
- package/docs/classes/services.EventDestinations.html +21 -12
- package/docs/classes/services.EventSources.html +6 -6
- package/docs/classes/services.EventSubscriptions.html +20 -11
- package/docs/classes/services.FailoverBackends.html +20 -11
- package/docs/classes/services.HTTPResponseBackends.html +20 -11
- package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +8 -8
- package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +8 -8
- package/docs/classes/services.IPPolicies.html +20 -11
- package/docs/classes/services.IPPolicyRules.html +20 -11
- package/docs/classes/services.IPRestrictions.html +20 -11
- package/docs/classes/services.ReservedAddrs.html +20 -11
- package/docs/classes/services.ReservedDomains.html +26 -17
- package/docs/classes/services.SSHCertificateAuthorities.html +20 -11
- package/docs/classes/services.SSHCredentials.html +20 -11
- package/docs/classes/services.SSHHostCertificates.html +20 -11
- package/docs/classes/services.SSHUserCertificates.html +20 -11
- package/docs/classes/services.TCPEdgeBackendModule.html +8 -8
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +8 -8
- package/docs/classes/services.TLSCertificates.html +20 -11
- package/docs/classes/services.TLSEdgeBackendModule.html +8 -8
- package/docs/classes/services.TLSEdgeIPRestrictionModule.html +8 -8
- package/docs/classes/services.TLSEdgeMutualTLSModule.html +8 -8
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +8 -8
- package/docs/classes/services.TunnelGroupBackends.html +20 -11
- package/docs/classes/services.TunnelSessions.html +22 -13
- package/docs/classes/services.Tunnels.html +15 -6
- package/docs/classes/services.WeightedBackends.html +20 -11
- package/docs/index.html +8 -3
- package/docs/interfaces/client.NgrokConfig.html +2 -2
- package/docs/interfaces/datatypes.APIKey.html +28 -9
- package/docs/interfaces/datatypes.APIKeyCreate.html +23 -4
- package/docs/interfaces/datatypes.APIKeyList.html +3 -3
- package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
- package/docs/interfaces/datatypes.AWSAuth.html +2 -2
- package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
- package/docs/interfaces/datatypes.AWSRole.html +1 -1
- package/docs/interfaces/datatypes.AbuseReport.html +9 -9
- package/docs/interfaces/datatypes.AbuseReportCreate.html +3 -3
- package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
- package/docs/interfaces/datatypes.AgentIngress.html +49 -11
- package/docs/interfaces/datatypes.AgentIngressCertJob.html +224 -0
- package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +186 -0
- package/docs/interfaces/datatypes.AgentIngressCertStatus.html +186 -0
- package/docs/interfaces/datatypes.AgentIngressCreate.html +24 -5
- package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressUpdate.html +22 -3
- package/docs/interfaces/datatypes.ApplicationSession.html +357 -0
- package/docs/interfaces/datatypes.ApplicationSessionList.html +205 -0
- package/docs/interfaces/datatypes.ApplicationUser.html +338 -0
- package/docs/interfaces/datatypes.ApplicationUserList.html +205 -0
- package/docs/interfaces/datatypes.BrowserSession.html +205 -0
- package/docs/interfaces/datatypes.CertificateAuthority.html +16 -16
- package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +5 -5
- package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.Credential.html +30 -11
- package/docs/interfaces/datatypes.CredentialCreate.html +25 -6
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +5 -5
- package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
- package/docs/interfaces/datatypes.Endpoint.html +19 -19
- package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
- package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +7 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointList.html +3 -3
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +12 -12
- package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +80 -4
- package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +218 -0
- package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
- package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
- package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
- package/docs/interfaces/datatypes.Error.html +4 -4
- package/docs/interfaces/datatypes.EventDestination.html +10 -10
- package/docs/interfaces/datatypes.EventDestinationCreate.html +6 -6
- package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
- package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventSource.html +2 -2
- package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
- package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
- package/docs/interfaces/datatypes.EventSourceList.html +2 -2
- package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
- package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
- package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
- package/docs/interfaces/datatypes.EventSubscription.html +10 -10
- package/docs/interfaces/datatypes.EventSubscriptionCreate.html +6 -6
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventTarget.html +22 -3
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetDatadog.html +224 -0
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/datatypes.FailoverBackend.html +9 -9
- package/docs/interfaces/datatypes.FailoverBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +11 -11
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +7 -7
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
- package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
- package/docs/interfaces/datatypes.HTTPSEdge.html +12 -12
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +7 -7
- package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +22 -22
- package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +18 -18
- package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +19 -19
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.IPPolicy.html +8 -8
- package/docs/interfaces/datatypes.IPPolicyCreate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +11 -11
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +7 -7
- package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
- package/docs/interfaces/datatypes.IPRestriction.html +11 -11
- package/docs/interfaces/datatypes.IPRestrictionCreate.html +7 -7
- package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
- package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
- package/docs/interfaces/datatypes.IdentityProvider.html +186 -0
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Location.html +224 -0
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +10 -10
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +5 -5
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomain.html +15 -15
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +6 -6
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +18 -18
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthority.html +10 -10
- package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +7 -7
- package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHCredential.html +30 -11
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +26 -7
- package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
- package/docs/interfaces/datatypes.SSHCredentialUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHHostCertificate.html +17 -17
- package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +11 -11
- package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificate.html +19 -19
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +13 -13
- package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TCPEdge.html +11 -11
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +7 -7
- package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.TLSCertificate.html +28 -28
- package/docs/interfaces/datatypes.TLSCertificateCreate.html +8 -8
- package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
- package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
- package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TLSEdge.html +13 -13
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +9 -9
- package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +8 -8
- package/docs/interfaces/datatypes.Tunnel.html +17 -17
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +10 -10
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
- package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.TunnelList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSession.html +12 -12
- package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
- package/docs/interfaces/datatypes.UserAgent.html +262 -0
- package/docs/interfaces/datatypes.WeightedBackend.html +9 -9
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
- package/docs/modules/datatypes.html +64 -0
- package/docs/modules/services.html +8 -0
- package/jest.config.js +2 -0
- package/lib/client.d.ts +9 -7
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +89 -119
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +392 -201
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/datatypes.js +4 -3
- package/lib/datatypes.js.map +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +16 -28
- package/lib/index.js.map +1 -1
- package/lib/services.d.ts +164 -126
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +3294 -3356
- package/lib/services.js.map +1 -1
- package/lib/util.d.ts.map +1 -1
- package/lib/util.js +35 -34
- package/lib/util.js.map +1 -1
- package/package.json +3 -3
- package/src/client.ts +16 -32
- package/src/datatypes.ts +413 -204
- package/src/index.ts +2 -0
- package/src/services.ts +768 -519
- package/src/util.ts +2 -0
- package/test/apikey.test.js +62 -63
|
@@ -83,6 +83,7 @@
|
|
|
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.AgentIngressCreate.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a></li>
|
|
86
87
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressCreate.html#description" class="tsd-kind-icon">description</a></li>
|
|
87
88
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressCreate.html#domain" class="tsd-kind-icon">domain</a></li>
|
|
88
89
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
@@ -93,13 +94,28 @@
|
|
|
93
94
|
</section>
|
|
94
95
|
<section class="tsd-panel-group tsd-member-group ">
|
|
95
96
|
<h2>Properties</h2>
|
|
97
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
98
|
+
<a name="certificateManagementPolicy" class="tsd-anchor"></a>
|
|
99
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate<wbr>Management<wbr>Policy</h3>
|
|
100
|
+
<div class="tsd-signature tsd-kind-icon">certificate<wbr>Management<wbr>Policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.AgentIngressCertPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngressCertPolicy</a></div>
|
|
101
|
+
<aside class="tsd-sources">
|
|
102
|
+
<ul>
|
|
103
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L68">datatypes.ts:68</a></li>
|
|
104
|
+
</ul>
|
|
105
|
+
</aside>
|
|
106
|
+
<div class="tsd-comment tsd-typography">
|
|
107
|
+
<div class="lead">
|
|
108
|
+
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.</p>
|
|
109
|
+
</div>
|
|
110
|
+
</div>
|
|
111
|
+
</section>
|
|
96
112
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
97
113
|
<a name="description" class="tsd-anchor"></a>
|
|
98
|
-
<h3>description</h3>
|
|
114
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
99
115
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
100
116
|
<aside class="tsd-sources">
|
|
101
117
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
118
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L62">datatypes.ts:62</a></li>
|
|
103
119
|
</ul>
|
|
104
120
|
</aside>
|
|
105
121
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +130,7 @@
|
|
|
114
130
|
<div class="tsd-signature tsd-kind-icon">domain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
115
131
|
<aside class="tsd-sources">
|
|
116
132
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
133
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L66">datatypes.ts:66</a></li>
|
|
118
134
|
</ul>
|
|
119
135
|
</aside>
|
|
120
136
|
<div class="tsd-comment tsd-typography">
|
|
@@ -125,11 +141,11 @@
|
|
|
125
141
|
</section>
|
|
126
142
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
127
143
|
<a name="metadata" class="tsd-anchor"></a>
|
|
128
|
-
<h3>metadata</h3>
|
|
144
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
129
145
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
130
146
|
<aside class="tsd-sources">
|
|
131
147
|
<ul>
|
|
132
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
148
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L64">datatypes.ts:64</a></li>
|
|
133
149
|
</ul>
|
|
134
150
|
</aside>
|
|
135
151
|
<div class="tsd-comment tsd-typography">
|
|
@@ -164,6 +180,9 @@
|
|
|
164
180
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
165
181
|
<a href="datatypes.AgentIngressCreate.html" class="tsd-kind-icon">Agent<wbr>Ingress<wbr>Create</a>
|
|
166
182
|
<ul>
|
|
183
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
184
|
+
<a href="datatypes.AgentIngressCreate.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a>
|
|
185
|
+
</li>
|
|
167
186
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
168
187
|
<a href="datatypes.AgentIngressCreate.html#description" class="tsd-kind-icon">description</a>
|
|
169
188
|
</li>
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">ingresses<span class="tsd-signature-symbol">:</span> <a href="datatypes.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</a><span class="tsd-signature-symbol">[]</span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L106">datatypes.ts:106</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
<div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
115
115
|
<aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L110">datatypes.ts:110</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
<div class="tsd-comment tsd-typography">
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
130
130
|
<aside class="tsd-sources">
|
|
131
131
|
<ul>
|
|
132
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L108">datatypes.ts:108</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -83,6 +83,7 @@
|
|
|
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.AgentIngressUpdate.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a></li>
|
|
86
87
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressUpdate.html#description" class="tsd-kind-icon">description</a></li>
|
|
87
88
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressUpdate.html#id" class="tsd-kind-icon">id</a></li>
|
|
88
89
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
@@ -93,13 +94,28 @@
|
|
|
93
94
|
</section>
|
|
94
95
|
<section class="tsd-panel-group tsd-member-group ">
|
|
95
96
|
<h2>Properties</h2>
|
|
97
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
98
|
+
<a name="certificateManagementPolicy" class="tsd-anchor"></a>
|
|
99
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate<wbr>Management<wbr>Policy</h3>
|
|
100
|
+
<div class="tsd-signature tsd-kind-icon">certificate<wbr>Management<wbr>Policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.AgentIngressCertPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngressCertPolicy</a></div>
|
|
101
|
+
<aside class="tsd-sources">
|
|
102
|
+
<ul>
|
|
103
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L78">datatypes.ts:78</a></li>
|
|
104
|
+
</ul>
|
|
105
|
+
</aside>
|
|
106
|
+
<div class="tsd-comment tsd-typography">
|
|
107
|
+
<div class="lead">
|
|
108
|
+
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.</p>
|
|
109
|
+
</div>
|
|
110
|
+
</div>
|
|
111
|
+
</section>
|
|
96
112
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
97
113
|
<a name="description" class="tsd-anchor"></a>
|
|
98
114
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
99
115
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
100
116
|
<aside class="tsd-sources">
|
|
101
117
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
118
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L74">datatypes.ts:74</a></li>
|
|
103
119
|
</ul>
|
|
104
120
|
</aside>
|
|
105
121
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +130,7 @@
|
|
|
114
130
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
115
131
|
<aside class="tsd-sources">
|
|
116
132
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
133
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L72">datatypes.ts:72</a></li>
|
|
118
134
|
</ul>
|
|
119
135
|
</aside>
|
|
120
136
|
</section>
|
|
@@ -124,7 +140,7 @@
|
|
|
124
140
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
125
141
|
<aside class="tsd-sources">
|
|
126
142
|
<ul>
|
|
127
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
143
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L76">datatypes.ts:76</a></li>
|
|
128
144
|
</ul>
|
|
129
145
|
</aside>
|
|
130
146
|
<div class="tsd-comment tsd-typography">
|
|
@@ -159,6 +175,9 @@
|
|
|
159
175
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
160
176
|
<a href="datatypes.AgentIngressUpdate.html" class="tsd-kind-icon">Agent<wbr>Ingress<wbr>Update</a>
|
|
161
177
|
<ul>
|
|
178
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
179
|
+
<a href="datatypes.AgentIngressUpdate.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a>
|
|
180
|
+
</li>
|
|
162
181
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
163
182
|
<a href="datatypes.AgentIngressUpdate.html#description" class="tsd-kind-icon">description</a>
|
|
164
183
|
</li>
|
|
@@ -0,0 +1,357 @@
|
|
|
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>ApplicationSession | @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.ApplicationSession.html">ApplicationSession</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Interface ApplicationSession</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">ApplicationSession</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.ApplicationSession.html#applicationUser" class="tsd-kind-icon">application<wbr>User</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#browserSession" class="tsd-kind-icon">browser<wbr>Session</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
|
|
89
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#edge" class="tsd-kind-icon">edge</a></li>
|
|
90
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#endpoint" class="tsd-kind-icon">endpoint</a></li>
|
|
91
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#expiresAt" class="tsd-kind-icon">expires<wbr>At</a></li>
|
|
92
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#id" class="tsd-kind-icon">id</a></li>
|
|
93
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#lastActive" class="tsd-kind-icon">last<wbr>Active</a></li>
|
|
94
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#publicUrl" class="tsd-kind-icon">public<wbr>Url</a></li>
|
|
95
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#route" class="tsd-kind-icon">route</a></li>
|
|
96
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ApplicationSession.html#uri" class="tsd-kind-icon">uri</a></li>
|
|
97
|
+
</ul>
|
|
98
|
+
</section>
|
|
99
|
+
</div>
|
|
100
|
+
</section>
|
|
101
|
+
</section>
|
|
102
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
103
|
+
<h2>Properties</h2>
|
|
104
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
105
|
+
<a name="applicationUser" class="tsd-anchor"></a>
|
|
106
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> application<wbr>User</h3>
|
|
107
|
+
<div class="tsd-signature tsd-kind-icon">application<wbr>User<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
108
|
+
<aside class="tsd-sources">
|
|
109
|
+
<ul>
|
|
110
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L191">datatypes.ts:191</a></li>
|
|
111
|
+
</ul>
|
|
112
|
+
</aside>
|
|
113
|
+
<div class="tsd-comment tsd-typography">
|
|
114
|
+
<div class="lead">
|
|
115
|
+
<p>application user this session is associated with</p>
|
|
116
|
+
</div>
|
|
117
|
+
</div>
|
|
118
|
+
</section>
|
|
119
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
120
|
+
<a name="browserSession" class="tsd-anchor"></a>
|
|
121
|
+
<h3>browser<wbr>Session</h3>
|
|
122
|
+
<div class="tsd-signature tsd-kind-icon">browser<wbr>Session<span class="tsd-signature-symbol">:</span> <a href="datatypes.BrowserSession.html" class="tsd-signature-type" data-tsd-kind="Interface">BrowserSession</a></div>
|
|
123
|
+
<aside class="tsd-sources">
|
|
124
|
+
<ul>
|
|
125
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L189">datatypes.ts:189</a></li>
|
|
126
|
+
</ul>
|
|
127
|
+
</aside>
|
|
128
|
+
<div class="tsd-comment tsd-typography">
|
|
129
|
+
<div class="lead">
|
|
130
|
+
<p>browser session details of the application session</p>
|
|
131
|
+
</div>
|
|
132
|
+
</div>
|
|
133
|
+
</section>
|
|
134
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
135
|
+
<a name="createdAt" class="tsd-anchor"></a>
|
|
136
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> created<wbr>At</h3>
|
|
137
|
+
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
138
|
+
<aside class="tsd-sources">
|
|
139
|
+
<ul>
|
|
140
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L193">datatypes.ts:193</a></li>
|
|
141
|
+
</ul>
|
|
142
|
+
</aside>
|
|
143
|
+
<div class="tsd-comment tsd-typography">
|
|
144
|
+
<div class="lead">
|
|
145
|
+
<p>timestamp when the user was created in RFC 3339 format</p>
|
|
146
|
+
</div>
|
|
147
|
+
</div>
|
|
148
|
+
</section>
|
|
149
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
150
|
+
<a name="edge" class="tsd-anchor"></a>
|
|
151
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> edge</h3>
|
|
152
|
+
<div class="tsd-signature tsd-kind-icon">edge<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
153
|
+
<aside class="tsd-sources">
|
|
154
|
+
<ul>
|
|
155
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L201">datatypes.ts:201</a></li>
|
|
156
|
+
</ul>
|
|
157
|
+
</aside>
|
|
158
|
+
<div class="tsd-comment tsd-typography">
|
|
159
|
+
<div class="lead">
|
|
160
|
+
<p>edge this session is associated with, null if the endpoint is agent-initiated</p>
|
|
161
|
+
</div>
|
|
162
|
+
</div>
|
|
163
|
+
</section>
|
|
164
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
165
|
+
<a name="endpoint" class="tsd-anchor"></a>
|
|
166
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> endpoint</h3>
|
|
167
|
+
<div class="tsd-signature tsd-kind-icon">endpoint<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
168
|
+
<aside class="tsd-sources">
|
|
169
|
+
<ul>
|
|
170
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L199">datatypes.ts:199</a></li>
|
|
171
|
+
</ul>
|
|
172
|
+
</aside>
|
|
173
|
+
<div class="tsd-comment tsd-typography">
|
|
174
|
+
<div class="lead">
|
|
175
|
+
<p>ephemeral endpoint this session is associated with</p>
|
|
176
|
+
</div>
|
|
177
|
+
</div>
|
|
178
|
+
</section>
|
|
179
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
180
|
+
<a name="expiresAt" class="tsd-anchor"></a>
|
|
181
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> expires<wbr>At</h3>
|
|
182
|
+
<div class="tsd-signature tsd-kind-icon">expires<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
183
|
+
<aside class="tsd-sources">
|
|
184
|
+
<ul>
|
|
185
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L197">datatypes.ts:197</a></li>
|
|
186
|
+
</ul>
|
|
187
|
+
</aside>
|
|
188
|
+
<div class="tsd-comment tsd-typography">
|
|
189
|
+
<div class="lead">
|
|
190
|
+
<p>timestamp when session expires in RFC 3339 format</p>
|
|
191
|
+
</div>
|
|
192
|
+
</div>
|
|
193
|
+
</section>
|
|
194
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
195
|
+
<a name="id" class="tsd-anchor"></a>
|
|
196
|
+
<h3>id</h3>
|
|
197
|
+
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
198
|
+
<aside class="tsd-sources">
|
|
199
|
+
<ul>
|
|
200
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L183">datatypes.ts:183</a></li>
|
|
201
|
+
</ul>
|
|
202
|
+
</aside>
|
|
203
|
+
<div class="tsd-comment tsd-typography">
|
|
204
|
+
<div class="lead">
|
|
205
|
+
<p>unique application session resource identifier</p>
|
|
206
|
+
</div>
|
|
207
|
+
</div>
|
|
208
|
+
</section>
|
|
209
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
210
|
+
<a name="lastActive" class="tsd-anchor"></a>
|
|
211
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> last<wbr>Active</h3>
|
|
212
|
+
<div class="tsd-signature tsd-kind-icon">last<wbr>Active<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
213
|
+
<aside class="tsd-sources">
|
|
214
|
+
<ul>
|
|
215
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L195">datatypes.ts:195</a></li>
|
|
216
|
+
</ul>
|
|
217
|
+
</aside>
|
|
218
|
+
<div class="tsd-comment tsd-typography">
|
|
219
|
+
<div class="lead">
|
|
220
|
+
<p>timestamp when the user was last active in RFC 3339 format</p>
|
|
221
|
+
</div>
|
|
222
|
+
</div>
|
|
223
|
+
</section>
|
|
224
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
225
|
+
<a name="publicUrl" class="tsd-anchor"></a>
|
|
226
|
+
<h3>public<wbr>Url</h3>
|
|
227
|
+
<div class="tsd-signature tsd-kind-icon">public<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
228
|
+
<aside class="tsd-sources">
|
|
229
|
+
<ul>
|
|
230
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L187">datatypes.ts:187</a></li>
|
|
231
|
+
</ul>
|
|
232
|
+
</aside>
|
|
233
|
+
<div class="tsd-comment tsd-typography">
|
|
234
|
+
<div class="lead">
|
|
235
|
+
<p>URL of the hostport served by this endpoint</p>
|
|
236
|
+
</div>
|
|
237
|
+
</div>
|
|
238
|
+
</section>
|
|
239
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
240
|
+
<a name="route" class="tsd-anchor"></a>
|
|
241
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> route</h3>
|
|
242
|
+
<div class="tsd-signature tsd-kind-icon">route<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
243
|
+
<aside class="tsd-sources">
|
|
244
|
+
<ul>
|
|
245
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L203">datatypes.ts:203</a></li>
|
|
246
|
+
</ul>
|
|
247
|
+
</aside>
|
|
248
|
+
<div class="tsd-comment tsd-typography">
|
|
249
|
+
<div class="lead">
|
|
250
|
+
<p>route this session is associated with, null if the endpoint is agent-initiated</p>
|
|
251
|
+
</div>
|
|
252
|
+
</div>
|
|
253
|
+
</section>
|
|
254
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
255
|
+
<a name="uri" class="tsd-anchor"></a>
|
|
256
|
+
<h3>uri</h3>
|
|
257
|
+
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
258
|
+
<aside class="tsd-sources">
|
|
259
|
+
<ul>
|
|
260
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L185">datatypes.ts:185</a></li>
|
|
261
|
+
</ul>
|
|
262
|
+
</aside>
|
|
263
|
+
<div class="tsd-comment tsd-typography">
|
|
264
|
+
<div class="lead">
|
|
265
|
+
<p>URI of the application session API resource</p>
|
|
266
|
+
</div>
|
|
267
|
+
</div>
|
|
268
|
+
</section>
|
|
269
|
+
</section>
|
|
270
|
+
</div>
|
|
271
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
272
|
+
<nav class="tsd-navigation primary">
|
|
273
|
+
<ul>
|
|
274
|
+
<li class=" ">
|
|
275
|
+
<a href="../modules.html">Modules</a>
|
|
276
|
+
</li>
|
|
277
|
+
<li class=" tsd-kind-module">
|
|
278
|
+
<a href="../modules/client.html">client</a>
|
|
279
|
+
</li>
|
|
280
|
+
<li class="current tsd-kind-module">
|
|
281
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
282
|
+
</li>
|
|
283
|
+
<li class=" tsd-kind-module">
|
|
284
|
+
<a href="../modules/services.html">services</a>
|
|
285
|
+
</li>
|
|
286
|
+
</ul>
|
|
287
|
+
</nav>
|
|
288
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
289
|
+
<ul class="before-current">
|
|
290
|
+
</ul>
|
|
291
|
+
<ul class="current">
|
|
292
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
293
|
+
<a href="datatypes.ApplicationSession.html" class="tsd-kind-icon">Application<wbr>Session</a>
|
|
294
|
+
<ul>
|
|
295
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
296
|
+
<a href="datatypes.ApplicationSession.html#applicationUser" class="tsd-kind-icon">application<wbr>User</a>
|
|
297
|
+
</li>
|
|
298
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
299
|
+
<a href="datatypes.ApplicationSession.html#browserSession" class="tsd-kind-icon">browser<wbr>Session</a>
|
|
300
|
+
</li>
|
|
301
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
302
|
+
<a href="datatypes.ApplicationSession.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
|
|
303
|
+
</li>
|
|
304
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
305
|
+
<a href="datatypes.ApplicationSession.html#edge" class="tsd-kind-icon">edge</a>
|
|
306
|
+
</li>
|
|
307
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
308
|
+
<a href="datatypes.ApplicationSession.html#endpoint" class="tsd-kind-icon">endpoint</a>
|
|
309
|
+
</li>
|
|
310
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
311
|
+
<a href="datatypes.ApplicationSession.html#expiresAt" class="tsd-kind-icon">expires<wbr>At</a>
|
|
312
|
+
</li>
|
|
313
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
314
|
+
<a href="datatypes.ApplicationSession.html#id" class="tsd-kind-icon">id</a>
|
|
315
|
+
</li>
|
|
316
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
317
|
+
<a href="datatypes.ApplicationSession.html#lastActive" class="tsd-kind-icon">last<wbr>Active</a>
|
|
318
|
+
</li>
|
|
319
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
320
|
+
<a href="datatypes.ApplicationSession.html#publicUrl" class="tsd-kind-icon">public<wbr>Url</a>
|
|
321
|
+
</li>
|
|
322
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
323
|
+
<a href="datatypes.ApplicationSession.html#route" class="tsd-kind-icon">route</a>
|
|
324
|
+
</li>
|
|
325
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
326
|
+
<a href="datatypes.ApplicationSession.html#uri" class="tsd-kind-icon">uri</a>
|
|
327
|
+
</li>
|
|
328
|
+
</ul>
|
|
329
|
+
</li>
|
|
330
|
+
</ul>
|
|
331
|
+
<ul class="after-current">
|
|
332
|
+
</ul>
|
|
333
|
+
</nav>
|
|
334
|
+
</div>
|
|
335
|
+
</div>
|
|
336
|
+
</div>
|
|
337
|
+
<footer class="with-border-bottom">
|
|
338
|
+
<div class="container">
|
|
339
|
+
<h2>Legend</h2>
|
|
340
|
+
<div class="tsd-legend-group">
|
|
341
|
+
<ul class="tsd-legend">
|
|
342
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
343
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
344
|
+
</ul>
|
|
345
|
+
<ul class="tsd-legend">
|
|
346
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
347
|
+
</ul>
|
|
348
|
+
</div>
|
|
349
|
+
</div>
|
|
350
|
+
</footer>
|
|
351
|
+
<div class="container tsd-generator">
|
|
352
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
353
|
+
</div>
|
|
354
|
+
<div class="overlay"></div>
|
|
355
|
+
<script src="../assets/js/main.js"></script>
|
|
356
|
+
</body>
|
|
357
|
+
</html>
|