Official package
RevDesk TypeScript SDK
Install the official @revdesk/sdk TypeScript client for typed RevDesk API calls, pagination, idempotency, structured errors, and the bundled CLI.
What it is
The official RevDesk SDK turns the public OpenAPI contract into a typed TypeScript client for Node.js applications and agent runtimes. It keeps operation names, request shapes, response envelopes, scope requirements, and released API behavior close to the canonical schema. The public repository also contains the official RevDesk API and MCP agent skills, registry manifests, runnable examples, and package release history.
When to use RevDesk TypeScript SDK
- Build a TypeScript or JavaScript integration without hand-maintaining HTTP request and response types.
- Use common pagination, retry, idempotency, and structured-error behavior consistently.
- Inspect or contribute to the public SDK, CLI, agent skills, and MCP registry metadata.
Recommended workflow
- 1Install @revdesk/sdk from npm and create a client with a least-privilege API key.
- 2Call the typed resource method that matches the OpenAPI operation and handle its structured response.
- 3Pin a compatible version, read release notes before upgrades, and test mutations against approved destinations.
Safety and approval boundaries
- The SDK cannot grant access beyond the scopes on its credential.
- Automatic retries must remain bounded and must not repeat a non-idempotent action blindly.
- Keep the API key in an environment or secret store rather than committing it with application code.
