amesu/lib/api/guilds.js

Node.js SDK for QQ Bot.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.default = (request) => {
    return {
        /**
         * 获取 `guild_id` 指定的频道的详情。
         */
        getGuildInfo(guild_id) {
            return request.get(`/guilds/${guild_id}`);
        },
        /**
         * 获取 guild_id 指定的频道下的子频道列表。
         */
        getGuildChannels(guild_id) {
            return request.get(`/guilds/${guild_id}/channels`);
        },
        /**
         * 在 guild_id 指定的频道下创建一个子频道。
         */
        createGuildChannel(guild_id, params) {
            return request.post(`/guilds/${guild_id}/channels`, params);
        },
        /**
         * 获取 guild_id 指定的频道中所有成员的详情列表，支持分页。
         */
        getGuildMembers(guild_id, after = '0', limit = 1) {
            return request.get(`/guilds/${guild_id}/members?after=${after}&limit=${limit}`);
        },
        /**
         * 获取 guild_id 频道中指定 role_id 身份组下所有成员的详情列表，支持分页。
         */
        getGuildRoleMembers(guild_id, role_id, params) {
            const defaultParams = {
                start_index: '0',
                limit: 1,
            };
            return request.get(`/guilds/${guild_id}/roles/${role_id}/members`, {
                ...defaultParams,
                ...params,
            });
        },
        /**
         * 获取 guild_id 指定的频道中 user_id 对应成员的详细信息。
         */
        getGuildUserMember(guild_id, user_id) {
            return request.get(`/guilds/${guild_id}/members/${user_id}`);
        },
        /**
         * 删除 guild_id 指定的频道下的成员 user_id。
         */
        deleteGuildUserMember(guild_id, user_id, params) {
            return request.delete(`/guilds/${guild_id}/members/${user_id}`, params);
        },
        /**
         * 获取 guild_id 指定的频道下的身份组列表。
         */
        getGuildRoles(guild_id) {
            return request.get(`/guilds/${guild_id}/roles`);
        },
        /**
         * 用于在 guild_id 指定的频道下创建一个身份组。
         */
        createGuildRole(guild_id, params) {
            return request.post(`/guilds/${guild_id}/roles`, params);
        },
        /**
         * 修改频道 guild_id 下 role_id 指定的身份组。
         */
        updateGuildRole(guild_id, role_id, params) {
            return request.patch(`/guilds/${guild_id}/roles/${role_id}`, params);
        },
        /**
         * 删除频道 guild_id下 role_id 对应的身份组。
         */
        deleteGuildRole(guild_id, role_id) {
            return request.delete(`/guilds/${guild_id}/roles/${role_id}`);
        },
        /**
         * 将频道 guild_id 下的用户 user_id 添加到身份组 role_id 。
         */
        addGuildMemberRole(guild_id, user_id, role_id, params) {
            return request.put(`/guilds/${guild_id}/members/${user_id}/roles/${role_id}`, params);
        },
        /**
         * 将用户 user_id 从 频道 guild_id 的 role_id 身份组中移除。
         */
        deleteGuildMemberRole(guild_id, user_id, role_id, params) {
            return request.delete(`/guilds/${guild_id}/members/${user_id}/roles/${role_id}`, params);
        },
        /**
         * 用于获取机器人在频道 guild_id 内可以使用的权限列表。
         */
        getGuildApiPermissions(guild_id) {
            return request.get(`/guilds/${guild_id}/api_permission`);
        },
        /**
         * 发送机器人在频道接口权限的授权链接。
         */
        sendGuildApiPermissionDemand(guild_id, params) {
            return request.post(`/guilds/${guild_id}/api_permission/demand`, params);
        },
        /**
         * 用于获取机器人在频道 guild_id 内的消息频率设置。
         */
        getGuildMessageSetting(guild_id) {
            return request.get(`/guilds/${guild_id}/message/setting`);
        },
        /**
         * 用于将频道的全体成员（非管理员）禁言。
         */
        guildMute(guild_id, params) {
            return request.patch(`/guilds/${guild_id}/mute`, params);
        },
        /**
         * 用于禁言频道 guild_id 下的成员 user_id。
         */
        guildMemberMute(guild_id, user_id, params) {
            return request.patch(`/guilds/${guild_id}/members/${user_id}/mute`, params);
        },
        /**
         * 用于将频道的指定批量成员（非管理员）禁言。
         */
        guildMembersMute(guild_id, params) {
            return request.patch(`/guilds/${guild_id}/mute`, params);
        },
        /**
         * 用于创建频道全局公告，公告类型分为 消息类型的频道公告 和 推荐子频道类型的频道公告 。
         */
        createGuildAnnounce(guild_id, params) {
            return request.post(`/guilds/${guild_id}/announces`, params);
        },
        /**
         * 用于删除频道 guild_id 下指定 message_id 的全局公告。
         */
        deleteGuildAnnounce(guild_id, message_id) {
            return request.delete(`/guilds/${guild_id}/announces/${message_id}`);
        },
    };
};