@typed-discord/rest
    Preparing search index...

    Class Bot

    Client class for interacting with the Discord REST API with a Bot token.

    Index

    Constructors

    Methods

    actionGuildJoinRequest addGroupDMUser addGuildMember addGuildMemberRole addLobbyMember addMyMessageReaction addThreadMember applicationsGetActivityInstance banUserFromGuild botPartnerSdkToken botPartnerSdkUnmergeProvisionalAccount bulkBanUsersFromGuild bulkDeleteMessages bulkSetApplicationCommands bulkSetGuildApplicationCommands bulkUpdateGuildChannels bulkUpdateGuildRoles bulkUpdateLobbyMembers consumeEntitlement countGuildScheduledEventUsers createApplicationCommand createApplicationEmoji createAutoModerationRule createChannelInvite createDM createEntitlement createGuildApplicationCommand createGuildChannel createGuildEmoji createGuildRole createGuildScheduledEvent createGuildScheduledEventException createGuildSoundboardSound createGuildSticker createGuildTemplate createLinkedLobbyGuildInviteForSelf createLinkedLobbyGuildInviteForUser createLobby createLobbyMessage createMessage createOrJoinLobby createPin createStageInstance createThread createThreadFromMessage createWebhook crosspostMessage deleteAllMessageReactions deleteAllMessageReactionsByEmoji deleteApplicationCommand deleteApplicationEmoji deleteAutoModerationRule deleteChannel deleteChannelPermissionOverwrite deleteEntitlement deleteGroupDMUser deleteGuildApplicationCommand deleteGuildEmoji deleteGuildIntegration deleteGuildMember deleteGuildMemberRole deleteGuildRole deleteGuildScheduledEvent deleteGuildScheduledEventException deleteGuildSoundboardSound deleteGuildSticker deleteGuildTemplate deleteLobby deleteLobbyMember deleteMessage deleteMyMessageReaction deletePin deleteStageInstance deleteThreadMember deleteUserMessageReaction deleteWebhook deprecatedCreatePin deprecatedDeletePin deprecatedListPins editLobby editLobbyChannelLink followChannel getActiveGuildThreads getAnswerVoters getApplication getApplicationCommand getApplicationEmoji getApplicationRoleConnectionsMetadata getAutoModerationRule getBotGateway getChannel getEntitlement getEntitlements getGuild getGuildApplicationCommand getGuildApplicationCommandPermissions getGuildBan getGuildEmoji getGuildJoinRequests getGuildMember getGuildNewMemberWelcome getGuildPreview getGuildRole getGuildScheduledEvent getGuildsOnboarding getGuildSoundboardSound getGuildSticker getGuildVanityUrl getGuildWebhooks getGuildWelcomeScreen getGuildWidgetSettings getInviteTargetUsers getInviteTargetUsersJobStatus getLobby getLobbyMessages getMessage getMyApplication getMyOauth2Application getMyOauth2Authorization getMyUser getOpenidConnectUserinfo getSelfVoiceState getSkuSubscription getSkuSubscriptions getSoundboardDefaultSounds getStageInstance getSticker getStickerPack getThreadMember getUser getVoiceState getWebhook guildRoleMemberCounts guildSearch inviteRevoke joinThread leaveGuild leaveLobby leaveThread listApplicationCommands listApplicationEmojis listAutoModerationRules listChannelInvites listChannelWebhooks listGuildApplicationCommandPermissions listGuildApplicationCommands listGuildAuditLogEntries listGuildBans listGuildChannels listGuildEmojis listGuildIntegrations listGuildInvites listGuildMembers listGuildRoles listGuildScheduledEventExceptionUsers listGuildScheduledEvents listGuildScheduledEventUsers listGuildSoundboardSounds listGuildStickers listGuildTemplates listGuildVoiceRegions listMessageReactionsByEmoji listMessages listMyConnections listMyGuilds listMyPrivateArchivedThreads listPins listPrivateArchivedThreads listPublicArchivedThreads listThreadMembers listVoiceRegions pollExpire previewPruneGuild pruneGuild putGuildsOnboarding searchGuildMembers sendSoundboardSound setChannelPermissionOverwrite setGuildApplicationCommandPermissions syncGuildTemplate threadSearch triggerTypingIndicator unbanUserFromGuild updateApplication updateApplicationCommand updateApplicationEmoji updateApplicationRoleConnectionsMetadata updateAutoModerationRule updateChannel updateGuild updateGuildApplicationCommand updateGuildEmoji updateGuildIncidentActions updateGuildMember updateGuildRole updateGuildScheduledEvent updateGuildScheduledEventException updateGuildSoundboardSound updateGuildSticker updateGuildTemplate updateGuildWelcomeScreen updateGuildWidgetSettings updateInviteTargetUsers updateLobbyMessageExternalModerationMetadata updateMessage updateMyApplication updateMyGuildMember updateMyUser updateSelfVoiceState updateStageInstance updateUserMessageExternalModerationMetadata updateVoiceChannelStatus updateVoiceState updateWebhook uploadApplicationAttachment

    Constructors

    Methods

    • Approve or reject guild join request

      Parameters

      • guild_id: `${bigint}`
      • request_id: `${bigint}`
      • body: { action?: undefined; rejection_reason?: string | null }
        • Optionalaction?: undefined

          Whether to approve or reject the join request

        • Optionalrejection_reason?: string | null

          Reason for rejection. Only used when action is REJECTED

      • Optionalreason: string

      Returns Promise<GuildJoinRequestResponse>

    • Parameters

      • guild_id: `${bigint}`
      • user_id: `${bigint}`
      • role_id: `${bigint}`
      • Optionalreason: string

      Returns Promise<void>

    • Parameters

      • lobby_id: `${bigint}`
      • user_id: `${bigint}`
      • body: { flags?: 1 | null; metadata?: { [key: string]: string } | null }

      Returns Promise<LobbyMemberResponse>

    • Parameters

      • channel_id: `${bigint}`
      • message_id: `${bigint}`
      • emoji_name: string

      Returns Promise<void>

    • Parameters

      • channel_id: `${bigint}`
      • user_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • body: {
            external_user_id: string;
            preferred_global_name?: string | null;
            provisional_user_id?: `${bigint}` | null;
        }

      Returns Promise<ProvisionalTokenResponse>

    • Parameters

      • body: { external_user_id: string }

      Returns Promise<void>

    • Parameters

      • channel_id: `${bigint}`
      • body: { messages: `${bigint}`[] }

      Returns Promise<void>

    • Parameters

      • guild_id: `${bigint}`
      • body: {
            id?: `${bigint}` | null;
            lock_permissions?: boolean | null;
            parent_id?: `${bigint}` | null;
            position?: number | null;
        }[]
      • Optionalreason: string

      Returns Promise<void>

    • Parameters

      • application_id: `${bigint}`
      • entitlement_id: `${bigint}`

      Returns Promise<void>

    • Get the count of users subscribed to a guild scheduled event

      Parameters

      • guild_id: `${bigint}`
      • guild_scheduled_event_id: `${bigint}`
      • Optionalparameters: { guild_scheduled_event_exception_ids?: `${bigint}`[] }

      Returns Promise<ScheduledEventUserCountResponse>

    • Parameters

      • application_id: `${bigint}`
      • body: { image: string; name: string }

      Returns Promise<EmojiResponse>

    • Parameters

      • guild_id: `${bigint}`
      • body: { image: string; name: string; roles?: (`${bigint}` | null)[] | null }
      • Optionalreason: string

      Returns Promise<EmojiResponse>

    • Parameters

      • guild_id: `${bigint}`
      • body: { description?: string | null; file: string; name: string; tags: string }
      • Optionalreason: string

      Returns Promise<GuildStickerResponse>

    • Parameters

      • guild_id: `${bigint}`
      • body: { description?: string | null; name: string }
      • Optionalreason: string

      Returns Promise<GuildTemplateResponse>

    • Parameters

      • body: {
            flags?: 1 | null;
            idle_timeout_seconds?: number | null;
            members?: LobbyMemberRequest[] | null;
            metadata?: { [key: string]: string } | null;
            override_event_webhooks_url?: string | null;
        }

      Returns Promise<LobbyResponse>

    • Parameters

      • body: {
            flags?: 1 | null;
            idle_timeout_seconds?: number | null;
            lobby_metadata?: { [key: string]: string } | null;
            member_metadata?: { [key: string]: string } | null;
            secret: string;
        }

      Returns Promise<LobbyResponse>

    • Parameters

      • channel_id: `${bigint}`
      • message_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • body: {
            channel_id: `${bigint}`;
            guild_scheduled_event_id?: `${bigint}` | null;
            privacy_level?: StageInstancesPrivacyLevels | null;
            send_start_notification?: boolean | null;
            topic: string;
        }

      Returns Promise<StageInstanceResponse>

    • Parameters

      • channel_id: `${bigint}`
      • message_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • channel_id: `${bigint}`
      • message_id: `${bigint}`
      • emoji_name: string

      Returns Promise<void>

    • Parameters

      • application_id: `${bigint}`
      • command_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • application_id: `${bigint}`
      • emoji_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • guild_id: `${bigint}`
      • rule_id: `${bigint}`
      • Optionalreason: string

      Returns Promise<void>

    • Parameters

      • channel_id: `${bigint}`
      • overwrite_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • application_id: `${bigint}`
      • entitlement_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • channel_id: `${bigint}`
      • user_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • application_id: `${bigint}`
      • guild_id: `${bigint}`
      • command_id: `${bigint}`
      • Optionalreason: string

      Returns Promise<void>

    • Parameters

      • guild_id: `${bigint}`
      • emoji_id: `${bigint}`
      • Optionalreason: string

      Returns Promise<void>

    • Parameters

      • guild_id: `${bigint}`
      • integration_id: `${bigint}`
      • Optionalreason: string

      Returns Promise<void>

    • Parameters

      • guild_id: `${bigint}`
      • user_id: `${bigint}`
      • Optionalreason: string

      Returns Promise<void>

    • Parameters

      • guild_id: `${bigint}`
      • user_id: `${bigint}`
      • role_id: `${bigint}`
      • Optionalreason: string

      Returns Promise<void>

    • Parameters

      • guild_id: `${bigint}`
      • role_id: `${bigint}`
      • Optionalreason: string

      Returns Promise<void>

    • Parameters

      • guild_id: `${bigint}`
      • guild_scheduled_event_id: `${bigint}`
      • Optionalreason: string

      Returns Promise<void>

    • Delete an exception to a recurring guild scheduled event

      Parameters

      • guild_id: `${bigint}`
      • guild_scheduled_event_id: `${bigint}`
      • exception_id: `${bigint}`
      • Optionalreason: string

      Returns Promise<void>

    • Parameters

      • guild_id: `${bigint}`
      • sound_id: `${bigint}`
      • Optionalreason: string

      Returns Promise<void>

    • Parameters

      • guild_id: `${bigint}`
      • sticker_id: `${bigint}`
      • Optionalreason: string

      Returns Promise<void>

    • Deletes the specified lobby if it exists. It is safe to call even if the lobby is already deleted.

      Parameters

      • lobby_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • lobby_id: `${bigint}`
      • user_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • channel_id: `${bigint}`
      • message_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • channel_id: `${bigint}`
      • message_id: `${bigint}`
      • emoji_name: string

      Returns Promise<void>

    • Parameters

      • channel_id: `${bigint}`
      • message_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • channel_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • channel_id: `${bigint}`
      • user_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • channel_id: `${bigint}`
      • message_id: `${bigint}`
      • emoji_name: string
      • user_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • webhook_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • channel_id: `${bigint}`
      • message_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • channel_id: `${bigint}`
      • message_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • lobby_id: `${bigint}`
      • body: {
            flags?: 1 | null;
            idle_timeout_seconds?: number | null;
            members?: LobbyMemberRequest[] | null;
            metadata?: { [key: string]: string } | null;
            override_event_webhooks_url?: string | null;
        }

      Returns Promise<LobbyResponse>

    • Parameters

      • lobby_id: `${bigint}`
      • body: { channel_id?: `${bigint}` | null }

      Returns Promise<LobbyResponse>

    • Parameters

      • channel_id: `${bigint}`
      • message_id: `${bigint}`
      • answer_id: number
      • Optionalparameters: { after?: `${bigint}`; limit?: number }

      Returns Promise<PollAnswerDetailsResponse>

    • Parameters

      • application_id: `${bigint}`
      • emoji_id: `${bigint}`

      Returns Promise<EmojiResponse>

    • Parameters

      • application_id: `${bigint}`
      • Optionalparameters: {
            after?: `${bigint}`;
            before?: `${bigint}`;
            exclude_deleted?: boolean;
            exclude_ended?: boolean;
            guild_id?: `${bigint}`;
            limit?: number;
            only_active?: boolean;
            sku_ids?: string | (`${bigint}` | null)[];
            user_id?: `${bigint}`;
        }

      Returns Promise<EntitlementResponse[]>

    • List join requests for guild, optionally filtered by application status

      Parameters

      • guild_id: `${bigint}`
      • Optionalparameters: {
            after?: `${bigint}`;
            before?: `${bigint}`;
            limit?: number;
            status?: undefined;
        }

      Returns Promise<GuildJoinRequestsListResponse>

    • Get the target users for an invite.

      Parameters

      • code: string

      Returns Promise<unknown>

    • Get a subscription by its ID.

      Parameters

      • sku_id: `${bigint}`
      • subscription_id: `${bigint}`
      • Optionalparameters: { user_id?: `${bigint}` }

      Returns Promise<SubscriptionResponse>

    • Returns all subscriptions containing the SKU, filtered by user.

      Parameters

      • sku_id: `${bigint}`
      • Optionalparameters: {
            after?: `${bigint}`;
            before?: `${bigint}`;
            limit?: number;
            user_id?: `${bigint}`;
        }

      Returns Promise<SubscriptionResponse[]>

    • Parameters

      • channel_id: `${bigint}`
      • user_id: `${bigint}`
      • Optionalparameters: { with_member?: boolean }

      Returns Promise<ThreadMemberResponse>

    • Parameters

      • guild_id: `${bigint}`

      Returns Promise<{ [key: string]: number }>

    • Parameters

      • guild_id: `${bigint}`
      • Optionalparameters: {
            attachment_extension?: string[];
            attachment_filename?: string[];
            author_id?: `${bigint}`[];
            author_type?: AuthorType[];
            channel_id?: `${bigint}`[];
            content?: string;
            embed_provider?: string[];
            embed_type?: SearchableEmbedType[];
            has?: HasOption[];
            include_nsfw?: boolean;
            limit?: number;
            link_hostname?: string[];
            max_id?: `${bigint}`;
            mention_everyone?: boolean;
            mentions?: `${bigint}`[];
            mentions_role_id?: `${bigint}`[];
            min_id?: `${bigint}`;
            offset?: number;
            pinned?: boolean;
            replied_to_message_id?: `${bigint}`[];
            replied_to_user_id?: `${bigint}`[];
            slop?: number;
            sort_by?: SortingMode;
            sort_order?: SortingOrder;
        }

      Returns Promise<GuildSearchResponse | SearchIndexNotReadyResponse>

    • Parameters

      • channel_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • guild_id: `${bigint}`
      • Optionalreason: string

      Returns Promise<void>

    • Parameters

      • lobby_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • channel_id: `${bigint}`

      Returns Promise<void>

    • Parameters

      • application_id: `${bigint}`
      • guild_id: `${bigint}`
      • Optionalparameters: { with_localizations?: boolean }

      Returns Promise<ApplicationCommandResponse[] | null>

    • Parameters

      • guild_id: `${bigint}`
      • Optionalparameters: {
            action_type?: AuditLogActionTypes;
            after?: `${bigint}`;
            before?: `${bigint}`;
            limit?: number;
            target_id?: `${bigint}`;
            user_id?: `${bigint}`;
        }

      Returns Promise<GuildAuditLogResponse>

    • Parameters

      • guild_id: `${bigint}`
      • Optionalparameters: { after?: `${bigint}`; before?: `${bigint}`; limit?: number }

      Returns Promise<GuildBanResponse[] | null>

    • Parameters

      • guild_id: `${bigint}`
      • Optionalparameters: { after?: number; limit?: number }

      Returns Promise<GuildMemberResponse[]>

    • Get a list of users subscribed to a guild scheduled event exception

      Parameters

      • guild_id: `${bigint}`
      • guild_scheduled_event_id: `${bigint}`
      • guild_scheduled_event_exception_id: `${bigint}`
      • Optionalparameters: {
            after?: `${bigint}`;
            before?: `${bigint}`;
            limit?: number;
            with_member?: boolean;
        }

      Returns Promise<ScheduledEventUserResponse[] | null>

    • Parameters

      • guild_id: `${bigint}`
      • guild_scheduled_event_id: `${bigint}`
      • Optionalparameters: {
            after?: `${bigint}`;
            before?: `${bigint}`;
            limit?: number;
            with_member?: boolean;
        }

      Returns Promise<ScheduledEventUserResponse[] | null>

    • Parameters

      • channel_id: `${bigint}`
      • message_id: `${bigint}`
      • emoji_name: string
      • Optionalparameters: { after?: `${bigint}`; limit?: number; type?: ReactionTypes }

      Returns Promise<UserResponse[]>

    • Parameters

      • channel_id: `${bigint}`
      • Optionalparameters: {
            after?: `${bigint}`;
            around?: `${bigint}`;
            before?: `${bigint}`;
            limit?: number;
        }

      Returns Promise<MessageResponse[] | null>

    • Parameters

      • Optionalparameters: {
            after?: `${bigint}`;
            before?: `${bigint}`;
            limit?: number;
            with_counts?: boolean;
        }

      Returns Promise<MyGuildResponse[] | null>

    • Parameters

      • channel_id: `${bigint}`
      • Optionalparameters: { before?: `${bigint}`; limit?: number }

      Returns Promise<ThreadsResponse>

    • Parameters

      • channel_id: `${bigint}`
      • Optionalparameters: { before?: string; limit?: number }

      Returns Promise<ThreadsResponse>

    • Parameters

      • channel_id: `${bigint}`
      • Optionalparameters: { before?: string; limit?: number }

      Returns Promise<ThreadsResponse>

    • Parameters

      • channel_id: `${bigint}`
      • Optionalparameters: { after?: `${bigint}`; limit?: number; with_member?: boolean }

      Returns Promise<ThreadMemberResponse[]>

    • Parameters

      • guild_id: `${bigint}`
      • Optionalparameters: { days?: number; include_roles?: string | (`${bigint}` | null)[] }

      Returns Promise<GuildPruneResponse>

    • Parameters

      • channel_id: `${bigint}`
      • overwrite_id: `${bigint}`
      • body: {
            allow?: number | null;
            deny?: number | null;
            type?: ChannelPermissionOverwrites | null;
        }

      Returns Promise<void>

    • Parameters

      • application_id: `${bigint}`
      • emoji_id: `${bigint}`
      • body: { name?: string }

      Returns Promise<EmojiResponse>

    • Parameters

      • guild_id: `${bigint}`
      • emoji_id: `${bigint}`
      • body: { name?: string; roles?: (`${bigint}` | null)[] | null }
      • Optionalreason: string

      Returns Promise<EmojiResponse>

    • Parameters

      • guild_id: `${bigint}`
      • user_id: `${bigint}`
      • body: {
            channel_id?: `${bigint}` | null;
            communication_disabled_until?: string | null;
            deaf?: boolean | null;
            flags?: number | null;
            mute?: boolean | null;
            nick?: string | null;
            roles?: (`${bigint}` | null)[] | null;
        }
      • Optionalreason: string

      Returns Promise<void | GuildMemberResponse>

    • Parameters

      • guild_id: `${bigint}`
      • sticker_id: `${bigint}`
      • body: { description?: string | null; name?: string; tags?: string }
      • Optionalreason: string

      Returns Promise<GuildStickerResponse>

    • Parameters

      • guild_id: `${bigint}`
      • code: string
      • body: { description?: string | null; name?: string }
      • Optionalreason: string

      Returns Promise<GuildTemplateResponse>

    • Parameters

      • guild_id: `${bigint}`
      • body: { channel_id?: `${bigint}` | null; enabled?: boolean | null }
      • Optionalreason: string

      Returns Promise<WidgetSettingsResponse>

    • Update the target users for an existing invite.

      Parameters

      • code: string
      • body: { target_users_file: string }

      Returns Promise<void>

    • Update the external moderation metadata for a lobby message.

      Parameters

      • lobby_id: `${bigint}`
      • message_id: `${bigint}`
      • body: { [key: string]: string }

      Returns Promise<void>

    • Parameters

      • guild_id: `${bigint}`
      • body: {
            avatar?: string | null;
            banner?: string | null;
            bio?: string | null;
            nick?: string | null;
        }
      • Optionalreason: string

      Returns Promise<PrivateGuildMemberResponse>

    • Update the external moderation metadata for a user message (DM).

      Parameters

      • user_id_1: `${bigint}`
      • user_id_2: `${bigint}`
      • message_id: `${bigint}`
      • body: { [key: string]: string }

      Returns Promise<void>

    • Set a voice channel's status.

      Parameters

      • channel_id: `${bigint}`
      • body: { status?: string | null }
        • Optionalstatus?: string | null

          The new voice channel status

      Returns Promise<void>