teamdynamix-ts

Secure Node-first TypeScript client for the TeamDynamix Web API, generated from OpenAPI 3.1.

Quick start

import { createTeamDynamixClient } from 'teamdynamix-ts';

const { client } = await createTeamDynamixClient({
  tenant: 'api',
  tokenProvider: async () => process.env.TEAMDYNAMIX_TOKEN ?? '',
  environment: 'production',
  runtimeValidationMode: 'fail-closed',
});

const accounts = await client.referenceData.accounts();

Documentation

• Browse docs in docs/ with VitePress.
• Local docs dev server: pnpm run docs:dev
• Build docs: pnpm run docs:build
• Preview built docs: pnpm run docs:preview

API reference in docs

• Full spec page: docs/api/spec.md
• Operation pages: generated from docs/operations/[operationId].paths.ts
• Tag pages: generated from docs/tags/[tag].paths.ts

Development commands

• pnpm run typecheck — strict TypeScript checks
• pnpm run lint — Oxlint
• pnpm run format:check — formatting verification
• pnpm run lint:md — markdown lint checks
• pnpm run test — Vitest suite

Source of truth

• Canonical OpenAPI spec in repo: src/spec/openapi.yaml
• Enriched outputs and reports: output/
• Type generation source: output/openapi-types.json
• Generated declarations: src/generated/schema.d.ts

More detail

See the full documentation in docs/ for:

• SDK usage patterns and migration guidance
• Generated API reference
• contributor-focused architecture and workflow guidance