diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 609f329d2..6cdd3cb57 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -46,18 +46,33 @@ Example: ```ts +/** https://discord.com/developers/docs/resources/user#user-object */ export interface User { + /** The user's id */ id: string; + /** The user's username, not unique across the platform */ username: string; + /** The user's 4-digit discord-tag */ discriminator: string; + /** The user's avatar hash */ avatar: string | null; + /** Whether the user belongs to an OAuth2 application */ bot?: boolean; + /** Whether the user is an Official Discord System user (part of the urgent message system) */ system?: boolean; + /** Whether the user has two factor enabled on their account */ mfaEnabled?: boolean; + /** The user's chosen language option */ locale?: string; + /** Whether the email on this account has been verified */ verified?: boolean; - email?: string; - flags?: number; - premiumType?: number; + /** The user's email */ + email?: string | null; + /** The flags on a user's account */ + flags?: DiscordUserFlags; + /** The type of Nitro subscription on a user's account */ + premiumType?: DiscordPremiumTypes; + /** The public flags on a user's account */ + publicFlags?: DiscordUserFlags; } ```