@shuffl/sdk 0.6.1 → 0.6.3

package/README.md

@@ -32,7 +32,17 @@ const preview = await shuffl.programs.preview({
 
 `users` means people in the team directory, including people who have no web login. IDs are Shuffl person IDs, not Slack IDs or authentication account IDs.
 
-The client includes people and their profiles, teams and departments, access, identity links, programs and runs, Knowledge, invitations, People sync, onboarding and first 90 days check-ins, celebrations, Pulse, Praise, badges, communities, reminders, Home, the HR digest, HR requests, support, reports, exports, credentials and assistant conversations. A team key never gains company scope; company settings have their own key and live under `shuffl.company`, below. See the [permission reference](https://shuffl-rebuild.vercel.app/docs/api-permissions) for every method. Input and output types come directly from the portable public oRPC contract.
+A team key never gains company scope; company settings have their own key and live under `shuffl.company`, below. See the [permission reference](https://shuffl-rebuild.vercel.app/docs/api-permissions) for every method. Input and output types come directly from the portable public oRPC contract.
+
+## What the client covers
+
+- People: `users`, `profiles`, `identities`, `invitations`, `access`, `manager`, `timeOff` and `sync` (People Sync).
+- Groups: `groups` (lists, departments, synced groups, automations and their runs), `units` and `communities`.
+- Programs: `programs` and `runs` (Connections), `mentorship`, `network` (the org chart and introductions) and `playbooks` (onboarding, buddies, 30/60/90 plans and leaving).
+- Culture: `celebrations`, `pulse`, `praise`, `badges`, `reminders`, `home`, `getStarted` and `digest`.
+- Knowledge and HR: `knowledge` (pages, sources, templates, read-and-confirm and the handbook), `hr` (HR requests), `support` and `assistant`.
+- Workspace: `teams`, `team`, `channels`, `integrations`, `notifications`, `reports`, `exports` and `webhooks`.
+- Keys and receipts: `credentials`, `permissions`, `commands` and `operations`.
 
 Program creation requires a stable `requestKey`. Repeating the same creation request returns the existing program; using that key with different settings returns `CONFLICT`. Programs start paused unless `draft: false` is explicitly supplied. Updates require `expectedRevision`. Run requests require a preview and request key and return a durable run ID; poll `runs.get` for status. The application scheduler owns execution and delivery.
 
@@ -48,7 +58,7 @@ Use `ORPCError.code` for errors (`UNAUTHORIZED`, `FORBIDDEN`, `BAD_REQUEST`, `NO
 
 ## Webhooks
 
-Shuffl can call your HTTPS endpoint when something happens in a workspace (#643). Add an endpoint in Settings → Webhooks or with `webhooks.create`, keep the `whsec_…` signing secret it returns, and check every delivery against it before you trust it. Pass the raw body, before any JSON parsing:
+Shuffl can call your HTTPS endpoint when something happens in a workspace. Add an endpoint in Settings → Webhooks or with `webhooks.create`, keep the `whsec_…` signing secret it returns, and check every delivery against it before you trust it. Pass the raw body, before any JSON parsing:
 
 ```ts
 import { verifyWebhook, WebhookVerificationError } from '@shuffl/sdk';
@@ -105,3 +115,7 @@ await shuffl.company.members.remove({ userId: page.items[0]!.userId });
 `shuffl.company.current()` returns the key's company and grants. Every other method needs its grant: `company.details`, `company.workspaces.list`, `company.members.list`, `company.emailDomains.list`, `company.slack.list`, `company.rename`, `company.workspaces.setDefault` and `company.members.remove`. `members.list` pages with `limit` and `cursor` like `users.list`. Company writes run once when called and take no `requestKey`. A company key can't call the workspace methods, and a workspace key can't call `shuffl.company`; the SDK refuses the wrong kind with `UNAUTHORIZED` before sending a request. See [company keys](https://shuffl-rebuild.vercel.app/docs/api-permissions#company-keys).
 
 Full guide: [Use the SDK and HTTP API](https://shuffl-rebuild.vercel.app/docs/sdk).
+
+## License
+
+MIT © Shuffl LLC. See [LICENSE](./LICENSE).

package/dist/index.d.ts

@@ -5,7 +5,7 @@ export { ORPCError } from '@orpc/client';
 export type { CompanyPermission, Permission, PermissionDefinition, Scope, } from '@shuffl/api-contracts';
 export { isWebhookEventType, signWebhook, verifyWebhook, type WebhookActor, type WebhookEvent, type WebhookEventData, type WebhookEventGroup, type WebhookEventType, WebhookVerificationError, webhookApiVersion, webhookEventCatalog, webhookEventGroups, webhookEventTypes, } from '@shuffl/api-contracts/webhooks';
 export type ShufflClient = ContractRouterClient<ShufflContract>;
-/** The company API (#1692), for a company key (shuffl_company_). */
+/** The company API, for a company key (shuffl_company_). */
 export type ShufflCompanyClient = ContractRouterClient<ShufflCompanyContract>;
 export interface ShufflOptions {
     /**

package/dist/index.js

@@ -4,7 +4,7 @@ import { isContractProcedure } from '@orpc/contract';
 import { contract } from '@shuffl/api-contracts';
 import { companyContract, } from '@shuffl/api-contracts/company';
 export { ORPCError } from '@orpc/client';
-// #643: check and type the webhooks Shuffl sends.
+// Check and type the webhooks Shuffl sends.
 export { isWebhookEventType, signWebhook, verifyWebhook, WebhookVerificationError, webhookApiVersion, webhookEventCatalog, webhookEventGroups, webhookEventTypes, } from '@shuffl/api-contracts/webhooks';
 import { sdkVersion } from './version.js';
 // Which SDK release (and, for the CLI, which CLI release) made a request,
@@ -66,7 +66,7 @@ const statusCodes = {
     409: 'CONFLICT',
     429: 'TOO_MANY_REQUESTS',
 };
-// The company API (#1692) is REST under /api/v1/company, so its client is
+// The company API is REST under /api/v1/company, so its client is
 // built from the contract's routes rather than the RPC link.
 function companyClient(base, options, client) {
     const procedure = ({ method, path }) => async (input, call) => {

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const sdkVersion = "0.6.1";
+export declare const sdkVersion = "0.6.3";

package/dist/version.js

@@ -1,3 +1,3 @@
 // The published version, sent in the x-shuffl-client header so Shuffl can
 // tell which SDK release calls it. `bun sdk:version X.Y.Z` writes it.
-export const sdkVersion = '0.6.1';
+export const sdkVersion = '0.6.3';

package/package.json

@@ -2,9 +2,9 @@
   "dependencies": {
     "@orpc/client": "1.15.3",
     "@orpc/contract": "1.15.3",
-    "@shuffl/api-contracts": "0.6.1"
+    "@shuffl/api-contracts": "0.6.3"
   },
-  "description": "TypeScript client for the Shuffl API: people, teams, knowledge, programs and management commands.",
+  "description": "TypeScript client for the Shuffl API: people, groups, knowledge, playbooks, programs and management commands.",
   "engines": {
     "node": ">=22"
   },
@@ -34,5 +34,5 @@
   "sideEffects": false,
   "type": "module",
   "types": "./dist/index.d.ts",
-  "version": "0.6.1"
+  "version": "0.6.3"
 }