Add types for waitlist entry

Author: SarahSoutoul

.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'],

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,
   ) {}