disgroove 1.3.1 → 1.3.3-dev.1

package/dist/lib/structures/Guild.d.ts

@@ -0,0 +1,462 @@
+import { ApplicationCommand, AuditLog, AutoModerationRule, Base, Channel, Emoji, GuildMember, GuildScheduledEvent, GuildTemplate, Integration, Invite, Role, StageInstance, Sticker, VoiceState, Webhook } from ".";
+import type { Client } from "../Client";
+import { type File } from "../rest";
+import type { JSONAutoModerationAction, JSONBan, JSONDefaultReaction, JSONForumTag, JSONGuild, JSONGuildApplicationCommandPermissions, JSONGuildOnboarding, JSONGuildPreview, JSONGuildScheduledEventEntityMetadata, JSONGuildScheduledEventUser, JSONGuildTemplate, JSONGuildWidget, JSONGuildWidgetSettings, JSONOnboardingPrompt, JSONOverwrite, PresenceUpdateEventFields, JSONThreadMember, JSONVoiceRegion, JSONWelcomeScreen, JSONWelcomeScreenChannel, RawGuild, RawGuildCreateEventExtraFields, JSONGuildCreateEventExtraFields, JSONTriggerMetadata, JSONApplicationCommandOption } from "../types";
+import type { ActionTypes, ApplicationCommandTypes, ChannelTypes, DefaultMessageNotificationLevel, EventTypes, ExplicitContentFilterLevel, ForumLayoutTypes, GuildFeatures, GuildMemberFlags, GuildNSFWLevel, GuildScheduledEventEntityTypes, GuildScheduledEventPrivacyLevel, GuildScheduledEventStatus, ImageWidgetStyleOptions, Locale, MFALevel, OnboardingMode, PremiumTier, SortOrderTypes, SystemChannelFlags, TriggerTypes, VerificationLevel, VideoQualityModes } from "../constants";
+/** https://discord.com/developers/docs/resources/guild */
+export declare class Guild extends Base {
+    protected raw: RawGuild & Partial<RawGuildCreateEventExtraFields>;
+    name: string;
+    icon: string | null;
+    iconHash?: string | null;
+    splash: string | null;
+    discoverySplash: string | null;
+    owner?: boolean;
+    ownerId: string;
+    permissions?: string;
+    region?: string | null;
+    afkChannelId: string | null;
+    afkTimeout: number;
+    widgetEnabled?: boolean;
+    widgetChannelId?: string | null;
+    verificationLevel: VerificationLevel;
+    defaultMessageNotifications: DefaultMessageNotificationLevel;
+    explicitContentFilter: ExplicitContentFilterLevel;
+    roles: Array<Role>;
+    emojis: Array<Emoji>;
+    features: Array<GuildFeatures>;
+    mfaLevel: MFALevel;
+    applicationId: string | null;
+    systemChannelId: string | null;
+    systemChannelFlags: SystemChannelFlags;
+    rulesChannelId: string | null;
+    maxPresences?: number | null;
+    maxMembers?: number;
+    vanityURLCode: string | null;
+    description: string | null;
+    banner: string | null;
+    premiumTier: PremiumTier;
+    premiumSubscriptionCount?: number;
+    preferredLocale: string;
+    publicUpdatesChannelId: string | null;
+    maxVideoChannelUsers?: number;
+    maxStageVideoChannelUsers?: number;
+    approximateMemberCount?: number;
+    approximatePresenceCount?: number;
+    welcomeScreen?: JSONWelcomeScreen;
+    nsfwLevel: GuildNSFWLevel;
+    stickers?: Array<Sticker>;
+    premiumProgressBarEnabled: boolean;
+    safetyAlertsChannelId: string | null;
+    joinedAt?: string;
+    large?: boolean;
+    unavailable?: boolean;
+    memberCount?: number;
+    voiceStates?: Array<VoiceState>;
+    members?: Array<GuildMember>;
+    channels?: Array<Channel>;
+    threads?: Array<Channel>;
+    presences?: Array<PresenceUpdateEventFields>;
+    stageInstances?: Array<StageInstance>;
+    guildScheduledEvents?: Array<GuildScheduledEvent>;
+    constructor(data: RawGuild & Partial<RawGuildCreateEventExtraFields>, client: Client);
+    protected patch(data: RawGuild & Partial<RawGuildCreateEventExtraFields>): void;
+    /** https://discord.com/developers/docs/resources/guild#add-guild-member */
+    addMember(userId: string, options: {
+        accessToken: string;
+        nick?: string;
+        roles?: Array<string>;
+        mute?: boolean;
+        deaf?: boolean;
+    }): Promise<GuildMember | null>;
+    /** https://discord.com/developers/docs/resources/guild#add-guild-member-role */
+    addMemberRole(userId: string, roleId: string, reason?: string): void;
+    /** https://discord.com/developers/docs/resources/guild#begin-guild-prune */
+    beginGuildPrune(options: {
+        days: number;
+        computePruneCount: boolean;
+        includeRoles: Array<string>;
+        reason?: string;
+    }, reason?: string): Promise<number>;
+    /** https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command */
+    createApplicationCommand(applicationId: string, options: {
+        name: string;
+        nameLocalizations?: Partial<Record<Locale, string>> | null;
+        description?: string;
+        descriptionLocalizations?: Partial<Record<Locale, string>> | null;
+        options?: Array<JSONApplicationCommandOption>;
+        defaultMemberPermissions?: string | null;
+        dmPermission?: boolean;
+        defaultPermission?: boolean | null;
+        type?: ApplicationCommandTypes;
+        nsfw?: boolean;
+    }): Promise<ApplicationCommand>;
+    /** https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule */
+    createAutoModerationRule(options: {
+        name: string;
+        eventType: EventTypes;
+        triggerType: TriggerTypes;
+        triggerMetadata?: JSONTriggerMetadata;
+        actions: Array<JSONAutoModerationAction>;
+        enabled?: boolean;
+        exemptRoles?: Array<string>;
+        exemptChannels?: Array<string>;
+    }, reason?: string): Promise<AutoModerationRule>;
+    /** https://discord.com/developers/docs/resources/guild#create-guild-ban */
+    createBan(userId: string, options?: {
+        deleteMessageDays?: number;
+        deleteMessageSeconds?: number;
+    }, reason?: string): void;
+    /** https://discord.com/developers/docs/resources/guild#create-guild-channel */
+    createChannel(options: {
+        name: string | null;
+        type?: ChannelTypes;
+        topic?: string | null;
+        bitrate?: number;
+        userLimit?: number;
+        rateLimitPerUser?: number;
+        position?: number;
+        permissionOverwrites?: Array<JSONOverwrite>;
+        parentId?: string | null;
+        nsfw?: boolean;
+        rtcRegion?: string | null;
+        videoQualityMode?: VideoQualityModes;
+        defaultAutoArchiveDuration?: number;
+        defaultReactionEmoji?: JSONDefaultReaction | null;
+        availableTags?: Array<JSONForumTag>;
+        defaultSortOrder?: SortOrderTypes | null;
+        defaultForumLayout?: ForumLayoutTypes;
+        defaultThreadRateLimitPerUser?: number;
+    }, reason?: string): Promise<Channel>;
+    /** https://discord.com/developers/docs/resources/emoji#create-guild-emoji */
+    createEmoji(options: {
+        name: string;
+        image: string;
+        roles: Array<string>;
+    }, reason?: string): Promise<Emoji>;
+    /** https://discord.com/developers/docs/resources/guild#create-guild-role */
+    createRole(options: {
+        name: string;
+        permissions: string;
+        color: number;
+        hoist: boolean;
+        icon: string | null;
+        unicodeEmoji: string | null;
+        mentionable: boolean;
+    }, reason?: string): Promise<Role>;
+    /** https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event */
+    createScheduledEvent(options: {
+        channelId?: string | null;
+        entityMetadata?: JSONGuildScheduledEventEntityMetadata | null;
+        name: string;
+        privacyLevel: GuildScheduledEventPrivacyLevel;
+        scheduledStartTime: string;
+        scheduledEndTime?: string | null;
+        description?: string | null;
+        entityType: GuildScheduledEventEntityTypes;
+        image?: string;
+    }, reason?: string): Promise<GuildScheduledEvent>;
+    /** https://discord.com/developers/docs/resources/sticker#create-guild-sticker */
+    createSticker(options: {
+        name: string;
+        description: string;
+        tags: string;
+        file: File;
+    }, reason?: string): Promise<Sticker>;
+    /** https://discord.com/developers/docs/resources/guild-template#create-guild-template */
+    createTemplate(options: {
+        name: string;
+        description?: string | null;
+    }): Promise<GuildTemplate>;
+    /** https://discord.com/developers/docs/resources/guild#delete-guild */
+    delete(): void;
+    /** https://discord.com/developers/docs/interactions/application-commands#delete-guild-application-command */
+    deleteApplicationCommand(applicationId: string, commandId: string): void;
+    /** https://discord.com/developers/docs/resources/auto-moderation#delete-auto-moderation-rule */
+    deleteAutoModerationRule(ruleId: string, reason?: string): void;
+    /** https://discord.com/developers/docs/resources/emoji#delete-guild-emoji */
+    deleteEmoji(emojiId: string, reason?: string): void;
+    /** https://discord.com/developers/docs/resources/guild#delete-guild-integration */
+    deleteIntegration(integrationId: string, reason?: string): void;
+    /** https://discord.com/developers/docs/resources/guild#delete-guild-role */
+    deleteRole(roleId: string, reason?: string): void;
+    /** https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event */
+    deleteScheduledEvent(scheduledEventId: string): void;
+    /** https://discord.com/developers/docs/resources/sticker#delete-guild-sticker */
+    deleteSticker(stickerId: string, reason?: string): void;
+    /** https://discord.com/developers/docs/resources/guild-template#delete-guild-template */
+    deleteTemplate(code: string): Promise<JSONGuildTemplate>;
+    /** https://discord.com/developers/docs/resources/guild#modify-guild */
+    edit(options: {
+        name?: string;
+        region?: string | null;
+        verificationLevel?: VerificationLevel;
+        defaultMessageNotifications?: DefaultMessageNotificationLevel;
+        explicitContentFilter?: ExplicitContentFilterLevel;
+        afkChannelId?: string | null;
+        afkTimeout?: number;
+        icon?: string | null;
+        ownerId?: string;
+        splash?: string | null;
+        discoverySplash?: string | null;
+        banner?: string | null;
+        systemChannelId?: string | null;
+        systemChannelFlags?: SystemChannelFlags;
+        rulesChannelId?: string | null;
+        publicUpdatesChannelId?: string | null;
+        preferredLocale?: string;
+        features?: Array<GuildFeatures>;
+        description?: string | null;
+        premiumProgressBarEnabled?: boolean;
+        safetyAlertsChannelId?: string | null;
+    }, reason?: string): Promise<Guild>;
+    /** https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command */
+    editApplicationCommand(applicationId: string, commandId: string, options: {
+        name?: string;
+        nameLocalizations?: Partial<Record<Locale, string>> | null;
+        description?: string;
+        descriptionLocalizations?: Partial<Record<Locale, string>> | null;
+        options?: Array<JSONApplicationCommandOption>;
+        defaultMemberPermissions?: string | null;
+        defaultPermission?: boolean | null;
+        dmPermission?: boolean;
+        nsfw?: boolean;
+    }): Promise<ApplicationCommand>;
+    /** https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule */
+    editAutoModerationRule(ruleId: string, options: {
+        name?: string;
+        eventType?: EventTypes;
+        triggerType?: TriggerTypes;
+        triggerMetadata?: JSONTriggerMetadata;
+        actions?: Array<JSONAutoModerationAction>;
+        enabled?: boolean;
+        exemptRoles?: Array<string>;
+        exemptChannels?: Array<string>;
+    }, reason?: string): Promise<AutoModerationRule>;
+    /** https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions */
+    editChannelPositions(options: Array<{
+        id: string;
+        position?: number | null;
+        lockPermissions?: boolean | null;
+        parentId?: string | null;
+    }>): void;
+    /** https://discord.com/developers/docs/resources/guild#modify-current-member */
+    editCurrentMember(options: {
+        nick: string | null;
+    }, reason?: string): Promise<GuildMember>;
+    /** https://discord.com/developers/docs/resources/guild#modify-current-user-voice-state */
+    editCurrentUserVoiceState(options: {
+        channelId?: string;
+        suppress?: boolean;
+        requestToSpeakTimestamp?: string | null;
+    }): void;
+    /** https://discord.com/developers/docs/resources/emoji#modify-guild-emoji */
+    editEmoji(emojiId: string, options: {
+        name?: string;
+        roles?: Array<string> | null;
+    }, reason?: string): Promise<Emoji>;
+    /** https://discord.com/developers/docs/resources/guild#modify-guild-member */
+    editMember(userId: string, options: {
+        nick?: string | null;
+        roles?: Array<string> | null;
+        mute?: boolean | null;
+        deaf?: boolean | null;
+        channelId?: string | null;
+        communicationDisabledUntil?: number | null;
+        flags?: GuildMemberFlags;
+    }, reason?: string): Promise<GuildMember>;
+    /** https://discord.com/developers/docs/resources/guild#modify-guild-mfa-level */
+    editMFALevel(options: {
+        level: MFALevel;
+    }, reason?: string): Promise<number>;
+    /** https://discord.com/developers/docs/resources/guild#modify-guild-onboarding */
+    editOnboarding(options: {
+        prompts: Array<JSONOnboardingPrompt>;
+        defaultChannelIds: Array<string>;
+        enabled: boolean;
+        mode: OnboardingMode;
+    }, reason?: string): void;
+    /** https://discord.com/developers/docs/resources/guild#modify-guild-role */
+    editRole(roleId: string, options?: {
+        name?: string | null;
+        permissions?: string | null;
+        color?: number | null;
+        hoist?: boolean | null;
+        icon?: string | null;
+        unicodeEmoji?: string | null;
+        mentionable?: boolean | null;
+    }, reason?: string): Promise<Role>;
+    /** https://discord.com/developers/docs/resources/guild#modify-guild-role-positions */
+    editRolePositions(options: Array<{
+        id: string;
+        position?: number | null;
+    }>): Promise<Array<Role>>;
+    /** https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event */
+    editScheduledEvent(scheduledEventId: string, options: {
+        channelId?: string | null;
+        entityMetadata?: JSONGuildScheduledEventEntityMetadata | null;
+        name?: string;
+        privacyLevel?: GuildScheduledEventPrivacyLevel;
+        scheduledStartTime?: string;
+        scheduledEndTime?: string;
+        description?: string | null;
+        entityType?: GuildScheduledEventEntityTypes;
+        status?: GuildScheduledEventStatus;
+        image?: string;
+    }, reason?: string): Promise<GuildScheduledEvent>;
+    /** https://discord.com/developers/docs/resources/sticker#modify-guild-sticker */
+    editSticker(stickerId: string, options: {
+        name?: string;
+        description?: string;
+        tags?: string;
+    }, reason?: string): Promise<Sticker>;
+    /** https://discord.com/developers/docs/resources/guild-template#modify-guild-template */
+    editTemplate(code: string, options: {
+        name?: string;
+        description?: string | null;
+    }): Promise<GuildTemplate>;
+    /** https://discord.com/developers/docs/resources/guild#modify-user-voice-state */
+    editUserVoiceState(userId: string, options: {
+        channelId?: string;
+        suppress?: boolean;
+        requestToSpeakTimestamp?: string | null;
+    }): void;
+    /** https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen */
+    editWelcomeScreen(options: {
+        enabled?: boolean | null;
+        welcomeChannels?: Array<JSONWelcomeScreenChannel> | null;
+        description?: string | null;
+    }, reason?: string): Promise<JSONWelcomeScreen>;
+    /** https://discord.com/developers/docs/resources/guild#modify-guild-widget */
+    editWidget(options: {
+        enabled?: boolean;
+        channelId?: boolean;
+    }, reason?: string): Promise<JSONGuildWidgetSettings>;
+    /** https://discord.com/developers/docs/resources/guild#list-active-guild-threads */
+    getActiveThreads(): Promise<Array<{
+        threads: Array<Channel>;
+        members: Array<JSONThreadMember>;
+    }>>;
+    /** https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command */
+    getApplicationCommand(applicationId: string, commandId: string): Promise<ApplicationCommand>;
+    /** https://discord.com/developers/docs/interactions/application-commands#get-guild-application-commands */
+    getApplicationCommands(applicationId: string, options?: {
+        withLocalizations?: boolean;
+    }): Promise<Array<ApplicationCommand>>;
+    /** https://discord.com/developers/docs/interactions/application-commands#get-application-command-permissions */
+    getApplicationCommandPermissions(applicationId: string, commandId: string): Promise<Array<JSONGuildApplicationCommandPermissions>>;
+    /** https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command-permissions */
+    getApplicationCommandsPermissions(applicationId: string): Promise<Array<JSONGuildApplicationCommandPermissions>>;
+    /** https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log */
+    getAuditLog(options?: {
+        userId?: string;
+        actionType?: ActionTypes;
+        before?: string;
+        after?: string;
+        limit?: number;
+    }): Promise<AuditLog>;
+    /** https://discord.com/developers/docs/resources/auto-moderation#get-auto-moderation-rule */
+    getAutoModerationRule(ruleId: string): Promise<AutoModerationRule>;
+    /** https://discord.com/developers/docs/resources/auto-moderation#list-auto-moderation-rules-for-guild */
+    getAutoModerationRules(): Promise<Array<AutoModerationRule>>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-ban */
+    getBan(userId: string): Promise<JSONBan>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-bans */
+    getBans(options?: {
+        limit?: number;
+        before?: string;
+        after?: string;
+    }): Promise<Array<JSONBan>>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-channels */
+    getChannels(): Promise<Array<Channel>>;
+    /** https://discord.com/developers/docs/resources/emoji#get-guild-emoji */
+    getEmoji(emojiId: string): Promise<Emoji>;
+    /** https://discord.com/developers/docs/resources/emoji#list-guild-emojis */
+    getEmojis(): Promise<Array<Emoji>>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-integrations */
+    getIntegrations(): Promise<Array<Integration>>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-invites */
+    getInvites(): Promise<Array<Invite>>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-member */
+    getMember(userId: string): Promise<GuildMember>;
+    /** https://discord.com/developers/docs/resources/guild#list-guild-members */
+    getMembers(): Promise<Array<GuildMember>>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-onboarding */
+    getOnboarding(): Promise<JSONGuildOnboarding>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-preview */
+    getPreview(): Promise<JSONGuildPreview>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-prune-count */
+    getPruneCount(options: {
+        days: number;
+        includeRoles: string | Array<string>;
+    }): Promise<number>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-roles */
+    getRoles(): Promise<Array<Role>>;
+    /** https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild */
+    getScheduledEvents(options?: {
+        withUserCount?: boolean;
+    }): Promise<Array<GuildScheduledEvent>>;
+    /** https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users */
+    getScheduledEventUsers(scheduledEventId: string, options?: {
+        limit?: number;
+        withMember?: boolean;
+        before?: string;
+        after?: string;
+    }): Promise<Array<JSONGuildScheduledEventUser>>;
+    /** https://discord.com/developers/docs/resources/sticker#get-guild-sticker */
+    getSticker(stickerId: string): Promise<Sticker>;
+    /** https://discord.com/developers/docs/resources/sticker#list-guild-stickers */
+    getStickers(): Promise<Array<Sticker>>;
+    /** https://discord.com/developers/docs/resources/guild-template#get-guild-template */
+    getTemplate(code: string): Promise<GuildTemplate>;
+    /** https://discord.com/developers/docs/resources/guild-template#get-guild-templates */
+    getTemplates(): Promise<Array<GuildTemplate>>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-vanity-url */
+    getVanityURL(): Promise<{
+        code: string;
+        uses: number;
+    }>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-voice-regions */
+    getVoiceRegions(): Promise<Array<JSONVoiceRegion>>;
+    /** https://discord.com/developers/docs/resources/webhook#get-guild-webhooks */
+    getWebhooks(): Promise<Array<Webhook>>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen */
+    getWelcomeScreen(): Promise<JSONWelcomeScreen>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-widget */
+    getWidget(): Promise<JSONGuildWidget>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-widget-image */
+    getWidgetImage(options?: {
+        style?: ImageWidgetStyleOptions;
+    }): Promise<string>;
+    /** https://discord.com/developers/docs/resources/guild#get-guild-widget-settings */
+    getWidgetSettings(): Promise<JSONGuildWidgetSettings>;
+    /** https://discord.com/developers/docs/resources/guild#remove-guild-ban */
+    removeBan(userId: string, reason?: string): void;
+    /** https://discord.com/developers/docs/resources/guild#remove-guild-member */
+    removeMember(userId: string, reason?: string): void;
+    /** https://discord.com/developers/docs/resources/guild#remove-guild-member-role */
+    removeMemberRole(userId: string, roleId: string, reason?: string): void;
+    /** https://discord.com/developers/docs/resources/guild#search-guild-members */
+    searchMembers(options: {
+        query: string;
+        limit?: number;
+    }): Promise<Array<GuildMember>>;
+    /** https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-guild-application-commands */
+    setApplicationCommands(applicationId: string, commands: Array<{
+        id?: string;
+        name: string;
+        nameLocalizations?: Partial<Record<Locale, string>> | null;
+        description?: string;
+        descriptionLocalizations?: Partial<Record<Locale, string>> | null;
+        options?: Array<JSONApplicationCommandOption>;
+        defaultMemberPermissions?: string | null;
+        dmPermission?: boolean;
+        defaultPermission?: boolean | null;
+        type: ApplicationCommandTypes;
+        nsfw?: boolean;
+    }>): Promise<Array<ApplicationCommand>>;
+    /** https://discord.com/developers/docs/resources/guild-template#sync-guild-template */
+    syncTemplate(code: string): Promise<GuildTemplate>;
+    toRaw(): RawGuild & Partial<RawGuildCreateEventExtraFields>;
+    toJSON(): JSONGuild & Partial<JSONGuildCreateEventExtraFields>;
+}