UNPKG

discord-api-types

Version:

Discord API typings that are kept up to date for use in bot library creation.

264 lines • 11.2 kB
"use strict"; /** * Types extracted from https://discord.com/developers/docs/resources/guild */ Object.defineProperty(exports, "__esModule", { value: true }); exports.MembershipScreeningFieldType = exports.GuildWidgetStyle = exports.IntegrationExpireBehavior = exports.GuildFeature = exports.GuildSystemChannelFlags = exports.GuildPremiumTier = exports.GuildVerificationLevel = exports.GuildNSFWLevel = exports.GuildMFALevel = exports.GuildExplicitContentFilter = exports.GuildDefaultMessageNotifications = void 0; /** * https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level * * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ var GuildDefaultMessageNotifications; (function (GuildDefaultMessageNotifications) { GuildDefaultMessageNotifications[GuildDefaultMessageNotifications["AllMessages"] = 0] = "AllMessages"; GuildDefaultMessageNotifications[GuildDefaultMessageNotifications["OnlyMentions"] = 1] = "OnlyMentions"; })(GuildDefaultMessageNotifications || (exports.GuildDefaultMessageNotifications = GuildDefaultMessageNotifications = {})); /** * https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level * * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ var GuildExplicitContentFilter; (function (GuildExplicitContentFilter) { GuildExplicitContentFilter[GuildExplicitContentFilter["Disabled"] = 0] = "Disabled"; GuildExplicitContentFilter[GuildExplicitContentFilter["MembersWithoutRoles"] = 1] = "MembersWithoutRoles"; GuildExplicitContentFilter[GuildExplicitContentFilter["AllMembers"] = 2] = "AllMembers"; })(GuildExplicitContentFilter || (exports.GuildExplicitContentFilter = GuildExplicitContentFilter = {})); /** * https://discord.com/developers/docs/resources/guild#guild-object-mfa-level * * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ var GuildMFALevel; (function (GuildMFALevel) { GuildMFALevel[GuildMFALevel["None"] = 0] = "None"; GuildMFALevel[GuildMFALevel["Elevated"] = 1] = "Elevated"; })(GuildMFALevel || (exports.GuildMFALevel = GuildMFALevel = {})); /** * https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level * * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ var GuildNSFWLevel; (function (GuildNSFWLevel) { GuildNSFWLevel[GuildNSFWLevel["Default"] = 0] = "Default"; GuildNSFWLevel[GuildNSFWLevel["Explicit"] = 1] = "Explicit"; GuildNSFWLevel[GuildNSFWLevel["Safe"] = 2] = "Safe"; GuildNSFWLevel[GuildNSFWLevel["AgeRestricted"] = 3] = "AgeRestricted"; })(GuildNSFWLevel || (exports.GuildNSFWLevel = GuildNSFWLevel = {})); /** * https://discord.com/developers/docs/resources/guild#guild-object-verification-level * * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ var GuildVerificationLevel; (function (GuildVerificationLevel) { /** * Unrestricted */ GuildVerificationLevel[GuildVerificationLevel["None"] = 0] = "None"; /** * Must have verified email on account */ GuildVerificationLevel[GuildVerificationLevel["Low"] = 1] = "Low"; /** * Must be registered on Discord for longer than 5 minutes */ GuildVerificationLevel[GuildVerificationLevel["Medium"] = 2] = "Medium"; /** * Must be a member of the guild for longer than 10 minutes */ GuildVerificationLevel[GuildVerificationLevel["High"] = 3] = "High"; /** * Must have a verified phone number */ GuildVerificationLevel[GuildVerificationLevel["VeryHigh"] = 4] = "VeryHigh"; })(GuildVerificationLevel || (exports.GuildVerificationLevel = GuildVerificationLevel = {})); /** * https://discord.com/developers/docs/resources/guild#guild-object-premium-tier * * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ var GuildPremiumTier; (function (GuildPremiumTier) { GuildPremiumTier[GuildPremiumTier["None"] = 0] = "None"; GuildPremiumTier[GuildPremiumTier["Tier1"] = 1] = "Tier1"; GuildPremiumTier[GuildPremiumTier["Tier2"] = 2] = "Tier2"; GuildPremiumTier[GuildPremiumTier["Tier3"] = 3] = "Tier3"; })(GuildPremiumTier || (exports.GuildPremiumTier = GuildPremiumTier = {})); /** * https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags * * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ var GuildSystemChannelFlags; (function (GuildSystemChannelFlags) { /** * Suppress member join notifications */ GuildSystemChannelFlags[GuildSystemChannelFlags["SuppressJoinNotifications"] = 1] = "SuppressJoinNotifications"; /** * Suppress server boost notifications */ GuildSystemChannelFlags[GuildSystemChannelFlags["SuppressPremiumSubscriptions"] = 2] = "SuppressPremiumSubscriptions"; /** * Suppress server setup tips */ GuildSystemChannelFlags[GuildSystemChannelFlags["SuppressGuildReminderNotifications"] = 4] = "SuppressGuildReminderNotifications"; /** * Hide member join sticker reply buttons */ GuildSystemChannelFlags[GuildSystemChannelFlags["SuppressJoinNotificationReplies"] = 8] = "SuppressJoinNotificationReplies"; })(GuildSystemChannelFlags || (exports.GuildSystemChannelFlags = GuildSystemChannelFlags = {})); /** * https://discord.com/developers/docs/resources/guild#guild-object-guild-features * * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ var GuildFeature; (function (GuildFeature) { /** * Guild has access to set an animated guild banner image */ GuildFeature["AnimatedBanner"] = "ANIMATED_BANNER"; /** * Guild has access to set an animated guild icon */ GuildFeature["AnimatedIcon"] = "ANIMATED_ICON"; /** * Guild has access to set a guild banner image */ GuildFeature["Banner"] = "BANNER"; /** * Guild has access to use commerce features (i.e. create store channels) */ GuildFeature["Commerce"] = "COMMERCE"; /** * Guild can enable welcome screen, Membership Screening and discovery, and receives community updates */ GuildFeature["Community"] = "COMMUNITY"; /** * Guild is able to be discovered in the directory */ GuildFeature["Discoverable"] = "DISCOVERABLE"; /** * Guild is able to be featured in the directory */ GuildFeature["Featurable"] = "FEATURABLE"; /** * Guild has access to set an invite splash background */ GuildFeature["InviteSplash"] = "INVITE_SPLASH"; /** * Guild has enabled Membership Screening */ GuildFeature["MemberVerificationGateEnabled"] = "MEMBER_VERIFICATION_GATE_ENABLED"; /** * Guild has enabled monetization */ GuildFeature["MonetizationEnabled"] = "MONETIZATION_ENABLED"; /** * Guild has increased custom sticker slots */ GuildFeature["MoreStickers"] = "MORE_STICKERS"; /** * Guild has access to create news channels */ GuildFeature["News"] = "NEWS"; /** * Guild is partnered */ GuildFeature["Partnered"] = "PARTNERED"; /** * Guild can be previewed before joining via Membership Screening or the directory */ GuildFeature["PreviewEnabled"] = "PREVIEW_ENABLED"; /** * Guild has access to create private threads */ GuildFeature["PrivateThreads"] = "PRIVATE_THREADS"; GuildFeature["RelayEnabled"] = "RELAY_ENABLED"; /** * Guild is able to set role icons */ GuildFeature["RoleIcons"] = "ROLE_ICONS"; /** * Guild has access to the seven day archive time for threads */ GuildFeature["SevenDayThreadArchive"] = "SEVEN_DAY_THREAD_ARCHIVE"; /** * Guild has access to the three day archive time for threads */ GuildFeature["ThreeDayThreadArchive"] = "THREE_DAY_THREAD_ARCHIVE"; /** * Guild has enabled ticketed events */ GuildFeature["TicketedEventsEnabled"] = "TICKETED_EVENTS_ENABLED"; /** * Guild has access to set a vanity URL */ GuildFeature["VanityURL"] = "VANITY_URL"; /** * Guild is verified */ GuildFeature["Verified"] = "VERIFIED"; /** * Guild has access to set 384kbps bitrate in voice (previously VIP voice servers) */ GuildFeature["VIPRegions"] = "VIP_REGIONS"; /** * Guild has enabled the welcome screen */ GuildFeature["WelcomeScreenEnabled"] = "WELCOME_SCREEN_ENABLED"; })(GuildFeature || (exports.GuildFeature = GuildFeature = {})); /** * https://discord.com/developers/docs/resources/guild#integration-object-integration-expire-behaviors * * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ var IntegrationExpireBehavior; (function (IntegrationExpireBehavior) { IntegrationExpireBehavior[IntegrationExpireBehavior["RemoveRole"] = 0] = "RemoveRole"; IntegrationExpireBehavior[IntegrationExpireBehavior["Kick"] = 1] = "Kick"; })(IntegrationExpireBehavior || (exports.IntegrationExpireBehavior = IntegrationExpireBehavior = {})); /** * https://discord.com/developers/docs/resources/guild#get-guild-widget-image-widget-style-options * * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ var GuildWidgetStyle; (function (GuildWidgetStyle) { /** * Shield style widget with Discord icon and guild members online count */ GuildWidgetStyle["Shield"] = "shield"; /** * Large image with guild icon, name and online count. "POWERED BY DISCORD" as the footer of the widget */ GuildWidgetStyle["Banner1"] = "banner1"; /** * Smaller widget style with guild icon, name and online count. Split on the right with Discord logo */ GuildWidgetStyle["Banner2"] = "banner2"; /** * Large image with guild icon, name and online count. In the footer, Discord logo on the left and "Chat Now" on the right */ GuildWidgetStyle["Banner3"] = "banner3"; /** * Large Discord logo at the top of the widget. Guild icon, name and online count in the middle portion of the widget * and a "JOIN MY SERVER" button at the bottom */ GuildWidgetStyle["Banner4"] = "banner4"; })(GuildWidgetStyle || (exports.GuildWidgetStyle = GuildWidgetStyle = {})); /** * @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10. */ var MembershipScreeningFieldType; (function (MembershipScreeningFieldType) { /** * Server Rules */ MembershipScreeningFieldType["Terms"] = "TERMS"; })(MembershipScreeningFieldType || (exports.MembershipScreeningFieldType = MembershipScreeningFieldType = {})); //# sourceMappingURL=guild.js.map