@kaizenlabs/quinn-sdk
v1.2.0
Published
TypeScript SDK for Quinn Platform API.
Downloads
465
Readme
@kaizenlabs/quinn-sdk
Typed TypeScript SDK for Quinn Platform.
@kaizenlabs/quinn-sdk is an organization-scoped client for Quinn business domains such as members, roles, courses, assignments, sign-off, groups, programs, and knowledge.
Install
npm i @kaizenlabs/quinn-sdkUsage
import { Quinn } from "@kaizenlabs/quinn-sdk";
const quinn = new Quinn();
const org = await quinn.organizations.current();
const members = await quinn.members.list({ limit: 20 });
const signOff = await quinn.signOff.list({ limit: 10 });
console.log(org.organization?.name, members.items.length, signOff.items.length);Configuration
new Quinn() resolves configuration in this order:
- constructor input
- environment variables
- config file
Supported environment variables:
QUINN_API_URLQUINN_API_TOKENQUINN_ORG_IDQUINN_ALLOW_QUINN_MUTATIONQUINN_CONFIG_PATH
Default config file path:
~/.config/quinn/config.jsonMutation Guard
To block write operations:
import { Quinn } from "@kaizenlabs/quinn-sdk";
const quinn = new Quinn({
allowQuinnMutation: false,
});