Terms

Terms resource client for latest terms and acceptances

Access through sdk.terms on a Lomadee instance. Term acceptance operations are on sdk.terms.acceptances.

import type {
  TermData,
  CreateTermAcceptanceBody,
  TermAcceptanceStatus,
} from '@thelomadee/sdk/domains';

latest

On sdk.terms:

latest(): Promise<TermData>

Returns metadata for the latest terms document.

Returns

Promise<TermData> — see TermData.

Example

const term = await sdk.terms.latest();
console.log(term.version, term.fileUrl);

---

Acceptances

Access through sdk.terms.acceptances (type TermAcceptance).

create

create(body: CreateTermAcceptanceBody): Promise<TermAcceptanceStatus>

Records term acceptance for a user.

Parameters — CreateTermAcceptanceBody

userId · string · required

User identifier to associate with the acceptance.

Returns

Promise<TermAcceptanceStatus>.

Example

const status = await sdk.terms.acceptances.create({ userId: 'user-123' });

list

list(userId: string): Promise<TermAcceptanceStatus>

Retrieves acceptance status for a user.

userId · string · required

User identifier.

Returns

Promise<TermAcceptanceStatus>.

Example

const status = await sdk.terms.acceptances.list('user-123');

---

TermData

id · string · required

Term record identifier.

version · number · required

Term version number.

organizationId · string | null · required

Organization identifier, or null.

fileUrl · string · required

URL of the terms document file.

createdAt · string · required

Creation timestamp (string format not specified in SDK types).

updatedAt · string · required

Update timestamp (string format not specified in SDK types).

TermAcceptanceStatus

accepted · boolean · required

Acceptance flag.

terms · TermData

Optional embedded terms metadata (plural field name). See TermData.

Related

• Client
• Quickstart
• Error handling