afkChannelId
afkChannelId: null | string
afkTimeout
afkTimeout: 60 | 300 | 900 | 1800 | 3600
applicationId
applicationId: null | string
Optional
approximateMemberCount
approximateMemberCount?: number
Optional
approximatePresenceCount
approximatePresenceCount?: number
banner
banner: null | string
bans
bans: { bulkCreate: ( body: RESTPostAPIGuildBulkBanJSONBody, reason?: string, ) => Promise<RESTPostAPIGuildBulkBanResult>; create: ( memberId: string, body?: RESTPutAPIGuildBanJSONBody, reason?: string, ) => Promise<void>; fetch: (userId: string, force?: boolean) => Promise<GuildBan>; list: ( query?: RESTGetAPIGuildBansQuery, force?: boolean, ) => Promise<GuildBan[]>; remove: (memberId: string, reason?: string) => Promise<undefined>;} = ... channels
channels: { create: <T extends GuildChannelTypes = GuildChannelTypes>( body: RESTPostAPIGuildChannelJSONBody & { type: T }, ) => Promise<SeyfertChannelMap[T]>; delete: (id: string, reason?: string) => Promise<AllChannels>; edit: ( id: string, body: RESTPatchAPIChannelJSONBody, reason?: string, ) => Promise<AllChannels>; editPositions: ( body: RESTPatchAPIGuildChannelPositionsJSONBody, ) => Promise<undefined>; fetch: (id: string, force?: boolean) => Promise<AllChannels>; list: (force?: boolean) => Promise<AllChannels[]>;} = ... createdTimestamp
createdTimestamp: number
defaultMessageNotifications
defaultMessageNotifications: GuildDefaultMessageNotifications
description
description: null | string
discoverySplash
discoverySplash: null | string
emojis
emojis: { create: ( body: Omit<RESTPostAPIGuildEmojiJSONBody, "image"> & { image: ImageResolvable; }, ) => Promise<GuildEmoji>; edit: ( emojiId: string, body: RESTPatchAPIGuildEmojiJSONBody, reason?: string, ) => Promise<GuildEmoji>; fetch: (emojiId: string, force?: boolean) => Promise<GuildEmoji>; list: (force?: boolean) => Promise<GuildEmoji[]>;} = ... explicitContentFilter
explicitContentFilter: GuildExplicitContentFilter
features
features: GuildFeature[]
hubType
hubType: null | GuildHubType
Optional
iconHash
iconHash?: null | string
invites
invites: {
create: (
data: CreateInviteFromChannel,
) => Promise<
{
approximateMemberCount?: number;
approximatePresenceCount?: number;
channel: null
| { id: string; name: null | string; type: ChannelType };
code: string;
createdAt: string;
expiresAt?: null | string;
guild?: {
banner: null | string;
description: null | string;
features: GuildFeature[];
icon: null | string;
id: string;
name: string;
nsfwLevel: GuildNSFWLevel;
premiumSubscriptionCount?: number;
splash: null | string;
vanityUrlCode: null | string;
verificationLevel: GuildVerificationLevel;
};
guildScheduledEvent?: | {
channelId: string;
creator?: APIUser;
creatorId?: null
| string;
description?: null | string;
entityId: null | string;
entityMetadata: null;
entityType: StageInstance;
guildId: string;
id: string;
image?: null | string;
name: string;
privacyLevel: GuildScheduledEventPrivacyLevel;
recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
scheduledEndTime: null | string;
scheduledStartTime: string;
status: GuildScheduledEventStatus;
userCount?: number;
}
| {
channelId: string;
creator?: APIUser;
creatorId?: null
| string;
description?: null | string;
entityId: null | string;
entityMetadata: null;
entityType: Voice;
guildId: string;
id: string;
image?: null | string;
name: string;
privacyLevel: GuildScheduledEventPrivacyLevel;
recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
scheduledEndTime: null | string;
scheduledStartTime: string;
status: GuildScheduledEventStatus;
userCount?: number;
}
| {
channelId: null;
creator?: APIUser;
creatorId?: null
| string;
description?: null | string;
entityId: null | string;
entityMetadata: { location: string };
entityType: External;
guildId: string;
id: string;
image?: null | string;
name: string;
privacyLevel: GuildScheduledEventPrivacyLevel;
recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
scheduledEndTime: null | string;
scheduledStartTime: string;
status: GuildScheduledEventStatus;
userCount?: number;
};
inviter?: {
accentColor?: null
| number;
avatar: null | string;
avatarDecorationData?: null | APIAvatarDecorationData;
banner?: null | string;
bot?: boolean;
discriminator: string;
email?: null | string;
flags?: UserFlags;
globalName: null | string;
id: string;
locale?: string;
mfaEnabled?: boolean;
premiumType?: UserPremiumType;
publicFlags?: UserFlags;
system?: boolean;
username: string;
verified?: boolean;
};
maxAge: number;
maxUses: number;
targetApplication?: {
approximateGuildCount?: number;
approximateUserInstallCount?: number;
bot?: APIUser;
botPublic?: boolean;
botRequireCodeGrant?: boolean;
coverImage?: string;
customInstallUrl?: string;
description?: string;
flags?: ApplicationFlags;
guild?: APIPartialGuild;
guildId?: string;
icon?: null
| string;
id?: string;
installParams?: APIApplicationInstallParams;
integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap;
interactionsEndpointUrl?: null | string;
name?: string;
owner?: APIUser;
primarySkuId?: string;
privacyPolicyUrl?: string;
redirectUris?: string[];
roleConnectionsVerificationUrl?: null | string;
rpcOrigins?: string[];
slug?: string;
tags?: [string, string?, string?, string?, string?];
team?: null | APITeam;
termsOfServiceUrl?: string;
verifyKey?: string;
};
targetType?: InviteTargetType;
targetUser?: {
accentColor?: null
| number;
avatar: null | string;
avatarDecorationData?: null | APIAvatarDecorationData;
banner?: null | string;
bot?: boolean;
discriminator: string;
email?: null | string;
flags?: UserFlags;
globalName: null | string;
id: string;
locale?: string;
mfaEnabled?: boolean;
premiumType?: UserPremiumType;
publicFlags?: UserFlags;
system?: boolean;
username: string;
verified?: boolean;
};
temporary: boolean;
type: InviteType;
uses: number;
},
>;
delete: (
code: string,
reason?: string,
) => Promise<
{
approximateMemberCount?: number;
approximatePresenceCount?: number;
channel: null
| { id: string; name: null | string; type: ChannelType };
code: string;
expiresAt?: null | string;
guild?: {
banner: null | string;
description: null | string;
features: GuildFeature[];
icon: null | string;
id: string;
name: string;
nsfwLevel: GuildNSFWLevel;
premiumSubscriptionCount?: number;
splash: null | string;
vanityUrlCode: null | string;
verificationLevel: GuildVerificationLevel;
};
guildScheduledEvent?: | {
channelId: string;
creator?: APIUser;
creatorId?: null
| string;
description?: null | string;
entityId: null | string;
entityMetadata: null;
entityType: StageInstance;
guildId: string;
id: string;
image?: null | string;
name: string;
privacyLevel: GuildScheduledEventPrivacyLevel;
recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
scheduledEndTime: null | string;
scheduledStartTime: string;
status: GuildScheduledEventStatus;
userCount?: number;
}
| {
channelId: string;
creator?: APIUser;
creatorId?: null
| string;
description?: null | string;
entityId: null | string;
entityMetadata: null;
entityType: Voice;
guildId: string;
id: string;
image?: null | string;
name: string;
privacyLevel: GuildScheduledEventPrivacyLevel;
recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
scheduledEndTime: null | string;
scheduledStartTime: string;
status: GuildScheduledEventStatus;
userCount?: number;
}
| {
channelId: null;
creator?: APIUser;
creatorId?: null
| string;
description?: null | string;
entityId: null | string;
entityMetadata: { location: string };
entityType: External;
guildId: string;
id: string;
image?: null | string;
name: string;
privacyLevel: GuildScheduledEventPrivacyLevel;
recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
scheduledEndTime: null | string;
scheduledStartTime: string;
status: GuildScheduledEventStatus;
userCount?: number;
};
inviter?: {
accentColor?: null
| number;
avatar: null | string;
avatarDecorationData?: null | APIAvatarDecorationData;
banner?: null | string;
bot?: boolean;
discriminator: string;
email?: null | string;
flags?: UserFlags;
globalName: null | string;
id: string;
locale?: string;
mfaEnabled?: boolean;
premiumType?: UserPremiumType;
publicFlags?: UserFlags;
system?: boolean;
username: string;
verified?: boolean;
};
targetApplication?: {
approximateGuildCount?: number;
approximateUserInstallCount?: number;
bot?: APIUser;
botPublic?: boolean;
botRequireCodeGrant?: boolean;
coverImage?: string;
customInstallUrl?: string;
description?: string;
flags?: ApplicationFlags;
guild?: APIPartialGuild;
guildId?: string;
icon?: null
| string;
id?: string;
installParams?: APIApplicationInstallParams;
integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap;
interactionsEndpointUrl?: null | string;
name?: string;
owner?: APIUser;
primarySkuId?: string;
privacyPolicyUrl?: string;
redirectUris?: string[];
roleConnectionsVerificationUrl?: null | string;
rpcOrigins?: string[];
slug?: string;
tags?: [string, string?, string?, string?, string?];
team?: null | APITeam;
termsOfServiceUrl?: string;
verifyKey?: string;
};
targetType?: InviteTargetType;
targetUser?: {
accentColor?: null
| number;
avatar: null | string;
avatarDecorationData?: null | APIAvatarDecorationData;
banner?: null | string;
bot?: boolean;
discriminator: string;
email?: null | string;
flags?: UserFlags;
globalName: null | string;
id: string;
locale?: string;
mfaEnabled?: boolean;
premiumType?: UserPremiumType;
publicFlags?: UserFlags;
system?: boolean;
username: string;
verified?: boolean;
};
type: InviteType;
},
>;
list: () => Promise<
{
approximateMemberCount?: number;
approximatePresenceCount?: number;
channel: null
| { id: string; name: null | string; type: ChannelType };
code: string;
createdAt: string;
expiresAt?: null | string;
guild?: {
banner: null | string;
description: null | string;
features: GuildFeature[];
icon: null | string;
id: string;
name: string;
nsfwLevel: GuildNSFWLevel;
premiumSubscriptionCount?: number;
splash: null | string;
vanityUrlCode: null | string;
verificationLevel: GuildVerificationLevel;
};
guildScheduledEvent?: | {
channelId: string;
creator?: APIUser;
creatorId?: null
| string;
description?: null | string;
entityId: null | string;
entityMetadata: null;
entityType: StageInstance;
guildId: string;
id: string;
image?: null | string;
name: string;
privacyLevel: GuildScheduledEventPrivacyLevel;
recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
scheduledEndTime: null | string;
scheduledStartTime: string;
status: GuildScheduledEventStatus;
userCount?: number;
}
| {
channelId: string;
creator?: APIUser;
creatorId?: null
| string;
description?: null | string;
entityId: null | string;
entityMetadata: null;
entityType: Voice;
guildId: string;
id: string;
image?: null | string;
name: string;
privacyLevel: GuildScheduledEventPrivacyLevel;
recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
scheduledEndTime: null | string;
scheduledStartTime: string;
status: GuildScheduledEventStatus;
userCount?: number;
}
| {
channelId: null;
creator?: APIUser;
creatorId?: null
| string;
description?: null | string;
entityId: null | string;
entityMetadata: { location: string };
entityType: External;
guildId: string;
id: string;
image?: null | string;
name: string;
privacyLevel: GuildScheduledEventPrivacyLevel;
recurrenceRule: null | APIGuildScheduledEventRecurrenceRule;
scheduledEndTime: null | string;
scheduledStartTime: string;
status: GuildScheduledEventStatus;
userCount?: number;
};
inviter?: {
accentColor?: null
| number;
avatar: null | string;
avatarDecorationData?: null | APIAvatarDecorationData;
banner?: null | string;
bot?: boolean;
discriminator: string;
email?: null | string;
flags?: UserFlags;
globalName: null | string;
id: string;
locale?: string;
mfaEnabled?: boolean;
premiumType?: UserPremiumType;
publicFlags?: UserFlags;
system?: boolean;
username: string;
verified?: boolean;
};
maxAge: number;
maxUses: number;
targetApplication?: {
approximateGuildCount?: number;
approximateUserInstallCount?: number;
bot?: APIUser;
botPublic?: boolean;
botRequireCodeGrant?: boolean;
coverImage?: string;
customInstallUrl?: string;
description?: string;
flags?: ApplicationFlags;
guild?: APIPartialGuild;
guildId?: string;
icon?: null
| string;
id?: string;
installParams?: APIApplicationInstallParams;
integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap;
interactionsEndpointUrl?: null | string;
name?: string;
owner?: APIUser;
primarySkuId?: string;
privacyPolicyUrl?: string;
redirectUris?: string[];
roleConnectionsVerificationUrl?: null | string;
rpcOrigins?: string[];
slug?: string;
tags?: [string, string?, string?, string?, string?];
team?: null | APITeam;
termsOfServiceUrl?: string;
verifyKey?: string;
};
targetType?: InviteTargetType;
targetUser?: {
accentColor?: null
| number;
avatar: null | string;
avatarDecorationData?: null | APIAvatarDecorationData;
banner?: null | string;
bot?: boolean;
discriminator: string;
email?: null | string;
flags?: UserFlags;
globalName: null | string;
id: string;
locale?: string;
mfaEnabled?: boolean;
premiumType?: UserPremiumType;
publicFlags?: UserFlags;
system?: boolean;
username: string;
verified?: boolean;
};
temporary: boolean;
type: InviteType;
uses: number;
}[],
>;
} = ...
joinedAt
joinedAt: StructPropState<number, State, "create"> large
large: StructPropState<boolean, State, "create"> Optional
maxMembers
maxMembers?: number
Optional
maxPresences
maxPresences?: null | number
Optional
maxStageVideoChannelUsers
maxStageVideoChannelUsers?: number
Optional
maxVideoChannelUsers
maxVideoChannelUsers?: number
memberCount
memberCount: StructPropState<number, State, "create"> members
members: { add: ( id: string, body: RESTPutAPIGuildMemberJSONBody, ) => Promise<undefined | GuildMember>; addRole: (memberId: string, id: string) => Promise<undefined>; ban: ( id: string, body?: RESTPutAPIGuildBanJSONBody, reason?: string, ) => Promise<void>; edit: ( id: string, body: RESTPatchAPIGuildMemberJSONBody, reason?: string, ) => Promise<GuildMember>; fetch: (memberId: string, force?: boolean) => Promise<GuildMember>; kick: (id: string, reason?: string) => Promise<void>; list: ( query?: RESTGetAPIGuildMembersQuery, force?: boolean, ) => Promise<GuildMember[]>; removeRole: (memberId: string, id: string) => Promise<undefined>; resolve: ( resolve: GuildMemberResolvable, ) => Promise<undefined | GuildMember>; search: ( query?: RESTGetAPIGuildMembersSearchQuery, ) => Promise<GuildMember[]>; unban: (id: string, reason?: string) => Promise<undefined>;} = ... mfaLevel
mfaLevel: GuildMFALevel
moderationRules
moderationRules: { create: ( body: RESTPostAPIAutoModerationRuleJSONBody, ) => Promise<AutoModerationRule>; delete: (ruleId: string, reason?: string) => Promise<undefined>; edit: ( ruleId: string, body: RESTPatchAPIAutoModerationRuleJSONBody, reason?: string, ) => Promise<AutoModerationRule>; fetch: (ruleId: string) => Promise<AutoModerationRule>; list: () => Promise<AutoModerationRule[]>;} = ... nsfwLevel
nsfwLevel: GuildNSFWLevel
Optional
owner
owner?: boolean
partnered
partnered: boolean
Optional
permissions
permissions?: string
preferredLocale
preferredLocale:
| "id"
| "en-US"
| "en-GB"
| "bg"
| "zh-CN"
| "zh-TW"
| "hr"
| "cs"
| "da"
| "nl"
| "fi"
| "fr"
| "de"
| "el"
| "hi"
| "hu"
| "it"
| "ja"
| "ko"
| "lt"
| "no"
| "pl"
| "pt-BR"
| "ro"
| "ru"
| "es-ES"
| "es-419"
| "sv-SE"
| "th"
| "tr"
| "uk"
| "vi"
premiumProgressBarEnabled
premiumProgressBarEnabled: boolean
Optional
premiumSubscriptionCount
premiumSubscriptionCount?: number
premiumTier
premiumTier: GuildPremiumTier
publicUpdatesChannelId
publicUpdatesChannelId: null | string
roles
roles: { create: (body: RESTPostAPIGuildRoleJSONBody) => Promise<GuildRole>; delete: (roleId: string, reason?: string) => Promise<void>; edit: ( roleId: string, body: RESTPatchAPIGuildRoleJSONBody, reason?: string, ) => Promise<GuildRole>; editPositions: ( body: RESTPatchAPIGuildRolePositionsJSONBody, ) => Promise<GuildRole[]>; list: (force?: boolean) => Promise<GuildRole[]>;} = ... rulesChannelId
rulesChannelId: null | string
safetyAlertsChannelId
safetyAlertsChannelId: null | string
shard
shard: undefined | Shard
splash
splash: null | string
stickers
stickers: { create: ( payload: CreateStickerBodyRequest, reason?: string, ) => Promise<Sticker>; delete: (stickerId: string, reason?: string) => Promise<void>; edit: ( stickerId: string, body: RESTPatchAPIGuildStickerJSONBody, reason?: string, ) => Promise<Sticker>; fetch: (stickerId: string, force?: boolean) => Promise<Sticker>; list: () => Promise<Sticker[]>;} = ... systemChannelFlags
systemChannelFlags: GuildSystemChannelFlags
systemChannelId
systemChannelId: null | string
Optional
unavailable
unavailable?: StructPropState<boolean, State, "create"> vanityUrlCode
vanityUrlCode: null | string
verificationLevel
verificationLevel: GuildVerificationLevel
verified
verified: boolean
webhooks
webhooks: { list: () => Promise<Webhook[]> } = ... Optional
welcomeScreen
welcomeScreen?: {
description: null | string;
welcomeChannels: {
channelId: string;
description: string;
emojiId: null | string;
emojiName: null | string;
}[];
}
widgetChannelId?: null | string
bannerURL gets the current guild banner as a string.