teamdynamix-ts

Type-safe TeamDynamix Web API client for Node.js — auto-generated reads, curated mutations, runtime validation, and auth helpers.

npm install @selfagency/teamdynamix-ts

import { createTeamDynamixClient, loginWithPassword } from 'teamdynamix-ts';

const { client } = await createTeamDynamixClient({
  tenant: 'mytenant',
  tokenProvider: loginWithPassword({
    tenant: 'mytenant',
    username: process.env.TD_USERNAME!,
    password: process.env.TD_PASSWORD!,
  }),
});

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

Full documentation

teamdynamix-ts.self.agency — quick start, SDK domain reference, mutation signatures, error handling, and API spec.

| Page | Contents | | ------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | Quick Start | Install, auth (password + service account), first queries, pagination | | Client Config | Timeout, retry policy, validation modes, sandbox | | SDK Domains | All 150+ read methods across 10 domains | | SDK Mutations | Create, update, delete with safety gates | | Helper Functions | projection, preview, bulk insert, report runner | | Custom Attributes | Reading and writing custom fields | | Error Handling | Error codes, HTTP errors, auth errors, validation errors | | API Reference | Interactive OpenAPI spec | | Developer Guide | Build, test, release, project structure |

Development

pnpm install
pnpm test          # Vitest
pnpm typecheck     # tsc --noEmit
pnpm lint          # oxlint
pnpm docs:dev      # VitePress local preview

Release

git tag v1.0.0
git push origin v1.0.0

The Release workflow builds, OIDC-authenticates with npm, and publishes with --provenance.