Skip to content

Commit 4a58c10

Browse files
authored
docs(repo): Add types for WaitlistEntry (#7784)
1 parent 5740640 commit 4a58c10

File tree

3 files changed

+27
-0
lines changed

3 files changed

+27
-0
lines changed

.changeset/clever-carrots-add.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
---

.typedoc/custom-plugin.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ const LINK_REPLACEMENTS = [
7373
['phone-number', '/docs/reference/backend/types/backend-phone-number'],
7474
['saml-account', '/docs/reference/backend/types/backend-saml-account'],
7575
['web3-wallet', '/docs/reference/backend/types/backend-web3-wallet'],
76+
['invitation', '/docs/reference/backend/types/backend-invitation'],
7677
['verify-token-options', '#verify-token-options'],
7778
['localization-resource', '/docs/guides/customizing-clerk/localization'],
7879
['confirm-checkout-params', '/docs/reference/javascript/types/billing-checkout-resource#parameters'],

packages/backend/src/api/resources/WaitlistEntry.ts

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,38 @@ import type { WaitlistEntryStatus } from './Enums';
22
import { Invitation } from './Invitation';
33
import type { WaitlistEntryJSON } from './JSON';
44

5+
/**
6+
* The Backend `WaitlistEntry` object holds information about a waitlist entry for a given email address.
7+
*/
58
export class WaitlistEntry {
69
constructor(
10+
/**
11+
* The unique identifier for this waitlist entry.
12+
*/
713
readonly id: string,
14+
/**
15+
* The email address to add to the waitlist.
16+
*/
817
readonly emailAddress: string,
18+
/**
19+
* The status of the waitlist entry.
20+
*/
921
readonly status: WaitlistEntryStatus,
22+
/**
23+
* The invitation associated with this waitlist entry.
24+
*/
1025
readonly invitation: Invitation | null,
26+
/**
27+
* The date when the waitlist entry was first created.
28+
*/
1129
readonly createdAt: number,
30+
/**
31+
* The date when the waitlist entry was last updated.
32+
*/
1233
readonly updatedAt: number,
34+
/**
35+
* Whether the waitlist entry is locked or not.
36+
*/
1337
readonly isLocked?: boolean,
1438
) {}
1539

0 commit comments

Comments
 (0)