From d07aae0f7ed6d3252f60dbbdcf290c6825b22f27 Mon Sep 17 00:00:00 2001 From: Sarah Soutoul Date: Thu, 5 Feb 2026 17:07:25 -0600 Subject: [PATCH 1/2] Add types for waitlist entry --- .typedoc/custom-plugin.mjs | 1 + .../src/api/resources/WaitlistEntry.ts | 24 +++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/.typedoc/custom-plugin.mjs b/.typedoc/custom-plugin.mjs index 5b137e740de..233c6b7c39a 100644 --- a/.typedoc/custom-plugin.mjs +++ b/.typedoc/custom-plugin.mjs @@ -73,6 +73,7 @@ const LINK_REPLACEMENTS = [ ['phone-number', '/docs/reference/backend/types/backend-phone-number'], ['saml-account', '/docs/reference/backend/types/backend-saml-account'], ['web3-wallet', '/docs/reference/backend/types/backend-web3-wallet'], + ['invitation', '/docs/reference/backend/types/backend-invitation'], ['verify-token-options', '#verify-token-options'], ['localization-resource', '/docs/guides/customizing-clerk/localization'], ['confirm-checkout-params', '/docs/reference/javascript/types/billing-checkout-resource#parameters'], diff --git a/packages/backend/src/api/resources/WaitlistEntry.ts b/packages/backend/src/api/resources/WaitlistEntry.ts index 58c2ee71cf1..e3b3557b38e 100644 --- a/packages/backend/src/api/resources/WaitlistEntry.ts +++ b/packages/backend/src/api/resources/WaitlistEntry.ts @@ -2,14 +2,38 @@ import type { WaitlistEntryStatus } from './Enums'; import { Invitation } from './Invitation'; import type { WaitlistEntryJSON } from './JSON'; +/** + * The Backend `WaitlistEntry` object holds information about a waitlist entry for a given email address. + */ export class WaitlistEntry { constructor( + /** + * The unique identifier for this waitlist entry. + */ readonly id: string, + /** + * The email address to add to the waitlist. + */ readonly emailAddress: string, + /** + * The status of the waitlist entry. + */ readonly status: WaitlistEntryStatus, + /** + * The invitation associated with this waitlist entry. + */ readonly invitation: Invitation | null, + /** + * The date when the waitlist entry was first created. + */ readonly createdAt: number, + /** + * The date when the waitlist entry was last updated. + */ readonly updatedAt: number, + /** + * Whether the waitlist entry is locked or not. + */ readonly isLocked?: boolean, ) {} From be7b1756b90e08c4d5aa28771e3fa3501e24071e Mon Sep 17 00:00:00 2001 From: Sarah Soutoul Date: Thu, 5 Feb 2026 17:16:40 -0600 Subject: [PATCH 2/2] Add changeset --- .changeset/clever-carrots-add.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .changeset/clever-carrots-add.md diff --git a/.changeset/clever-carrots-add.md b/.changeset/clever-carrots-add.md new file mode 100644 index 00000000000..a845151cc84 --- /dev/null +++ b/.changeset/clever-carrots-add.md @@ -0,0 +1,2 @@ +--- +---