invitations

The methods of pd.invitations. Inputs and outputs are described in Conventions; every method can also fail as described in Errors.

Methods

pd.invitations.list(input, init?)

List a workspace's pending invitations

GET /api/workspaces/{workspaceId}/invitations

Needs members.read. Neither accepted nor revoked, newest first. Expired invitations stay listed so they can be resent. The link itself is never returned: it exists only in the email.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.invitations.list({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.invitations.revoke(input, init?)

Revoke an invitation

DELETE /api/workspaces/{workspaceId}/invitations/{invitationId}

Needs members.invite. The emailed link stops working at once, the seat it held is freed, and the address can be invited again. 404 RESOURCE_NOT_FOUND when the invitation is unknown or was already accepted or revoked. Records a members.invitation_revoked audit entry.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.invitations.revoke({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  invitationId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.invitations.resend(input, init?)

Send an invitation again

POST /api/workspaces/{workspaceId}/invitations/{invitationId}/resend

Needs members.invite. Issues a new link valid for seven days and emails it; the previous link stops working. 403 FORBIDDEN when a role the invitation carries (the default role when it carries none) holds a permission the caller lacks, as when inviting; revoking has no such limit. Answers 429 RATE_LIMITED (with Retry-After) within a minute of the last send. Resending an expired invitation takes a seat again and can answer 429 QUOTA_EXCEEDED; one still open already holds its seat. 404 RESOURCE_NOT_FOUND when the invitation is unknown or was already accepted or revoked. The body is optional. The email is queued with the change and sent in the background. Records a members.invited audit entry.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.invitations.resend({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  invitationId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);