Service for accessing legal documents (privacy policy, terms of service, etc.).

Accessible via lynkow.legal. Legal documents are regular pages tagged with 'legal'. This service provides convenience methods to access them, but is deprecated in favor of the pages service.

Responses are cached for 5 minutes (SHORT TTL).

Access via: lynkow.legal

Methods

3 methods

clearCache

TypeScript
clearCache(): void

Invalidates all cached legal document responses.

Returns: void

getBySlug

TypeScript
getBySlug(slug: string, options?: BaseRequestOptions): Promise<LegalDocument>

Retrieves a single legal page by its slug, including resolved data and SEO settings. Cached for 5 minutes per slug+locale.

Parameter

Type

Description

slug

string

The page slug (e.g. 'privacy-policy', 'terms-of-service', 'cookie-policy')

options

BaseRequestOptions

Request options; use locale to fetch a specific localized version

Returns: Promise<LegalDocument>

TypeScript
// Deprecated -- migrate to pages service:
// Before: const privacy = await lynkow.legal.getBySlug('privacy-policy')
// After:
const privacy = await lynkow.pages.getBySlug('privacy-policy')
console.log(privacy.data.name, privacy.data.body)

list

TypeScript
list(options?: BaseRequestOptions): Promise<LegalDocument[]>

Retrieves all published pages tagged with 'legal'. Returns page summaries including slug, name, path, and locale. Cached for 5 minutes per locale.

Parameter

Type

Description

options

BaseRequestOptions

Request options; use locale to fetch localized versions

Returns: Promise<LegalDocument[]>

TypeScript
// Deprecated -- migrate to pages service:
// Before: const docs = await lynkow.legal.list()
// After:
const docs = await lynkow.pages.list({ tag: 'legal' })
docs.data.forEach(doc => console.log(doc.slug, doc.name))