invitations

Methods on junjo.invitations.

For the create-side methods, see junjo.groups.inviteByUserId, junjo.groups.inviteByCode, and junjo.groups.inviteByLink. The methods below operate on existing invitations.

list(groupId, opts?)

Lists invitations for a group, sorted newest-first. Cursor-based pagination via the Page<T> envelope. By default the response excludes used and expired invitations; pass includeUsed: true and/or includeExpired: true to include them.

let cursor: string | null | undefined;
do {
  const page = await junjo.invitations.list("grp_xyz" as GroupId, {
    limit: 50,
    cursor: cursor ?? undefined,
  });
  for (const invitation of page.items) {
    console.log(invitation.code, invitation.targetUserId);
  }
  cursor = page.nextCursor;
} while (cursor);

Options

Returns

Page<Invitation> with timestamps deserialized to Date.

Errors

See also

• GET /v1/groups/:id/invitations - the underlying HTTP route.

get(code)

Fetches an invitation by code. The underlying server route does not require an API key (anyone with the code can fetch the preview), but the SDK still sends the configured apiKey header on every request.

Returns Invitation | null: the SDK turns 404 not_found into null so callers can branch on if (invitation) without a try/catch. Other errors (invalid API key, network failure, etc.) throw JunjoError.

const invitation = await junjo.invitations.get("abcd1234abcd1234");
if (!invitation) {
  return; // unknown code, or the group was soft-deleted
}
if (invitation.usedAt) {
  // already redeemed
} else if (invitation.expiresAt && invitation.expiresAt < new Date()) {
  // expired
} else {
  // valid: render the accept UI
}

Errors

404 not_found is converted to null; it is not thrown.

See also

• GET /v1/invitations/:code - the underlying HTTP route.

revoke(code)

Revokes (deletes) an invitation by code. Returns void on success.

• An unused invitation is hard-deleted; a second revoke call returns the server’s not_found error (the row is gone).
• An already-used invitation is left in place (to preserve the redemption history); revoke returns void regardless of how many times it is called.

await junjo.invitations.revoke("abcd1234abcd1234");

Returns

Promise<void>.

Errors

See also

• DELETE /v1/invitations/:code - the underlying HTTP route.