@koishijs/plugin-adapter-discord 2.0.0-rc.1 → 2.0.3

package/lib/types/guild-member.d.ts

@@ -22,89 +22,195 @@ export interface GuildMember {
     /** total permissions of the member in the channel, including overwrites, returned when in the interaction object */
     permissions?: string;
 }
-/** https://discord.com/developers/docs/topics/gateway#guild-member-add-guild-member-add-extra-fields */
-export interface GuildMemberAddEvent extends GuildMember {
-    /** id of the guild */
-    guild_id: snowflake;
-}
-/** https://discord.com/developers/docs/topics/gateway#guild-member-remove-guild-member-remove-event-fields */
-export interface GuildMemberRemoveEvent {
-    /** the id of the guild */
-    guild_id: snowflake;
-    /** the user who was removed */
-    user: User;
-}
-/** https://discord.com/developers/docs/topics/gateway#guild-member-update-guild-member-update-event-fields */
-export interface GuildMemberUpdateEvent {
-    /** the id of the guild */
-    guild_id: snowflake;
-    /** user role ids */
-    roles: snowflake[];
-    /** the user */
-    user: User;
-    /** nickname of the user in the guild */
-    nick?: string;
-    /** the member's guild avatar hash */
-    avatar?: string;
-    /** when the user joined the guild */
-    joined_at?: timestamp;
-    /** when the user starting boosting the guild */
-    premium_since?: timestamp;
-    /** whether the user is deafened in voice channels */
-    deaf?: boolean;
-    /** whether the user is muted in voice channels */
-    mute?: boolean;
-    /** whether the user has not yet passed the guild's Membership Screening requirements */
-    pending?: boolean;
-}
-/** https://discord.com/developers/docs/topics/gateway#guild-members-chunk-guild-members-chunk-event-fields */
-export interface GuildMembersChunkEvent {
-    /** the id of the guild */
-    guild_id: snowflake;
-    /** set of guild members */
-    members: GuildMember[];
-    /** the chunk index in the expected chunks for this response (0 <= chunk_index < chunk_count) */
-    chunk_index: integer;
-    /** the total number of expected chunks for this response */
-    chunk_count: integer;
-    /** if passing an invalid id to REQUEST_GUILD_MEMBERS, it will be returned here */
-    not_found?: snowflake[];
-    /** if passing true to REQUEST_GUILD_MEMBERS, presences of the returned members will be here */
-    presences?: PresenceUpdateParams[];
-    /** the nonce used in the Guild Members Request */
-    nonce?: string;
+export declare namespace GuildMember {
+    namespace Params {
+        /** https://discord.com/developers/docs/resources/guild#list-guild-members-query-string-params */
+        interface List {
+            /** max number of members to return (1-1000) */
+            limit: integer;
+            /** the highest user id in the previous page */
+            after: snowflake;
+        }
+        /** https://discord.com/developers/docs/resources/guild#search-guild-members-query-string-params */
+        interface Search {
+            /** Query string to match username(s) and nickname(s) against. */
+            query: string;
+            /** max number of members to return (1-1000) */
+            limit: integer;
+        }
+        /** https://discord.com/developers/docs/resources/guild#add-guild-member-json-params */
+        interface Add {
+            /** an oauth2 access token granted with the guilds.join to the bot's application for the user you want to add to the guild */
+            access_token: string;
+            /** value to set user's nickname to */
+            nick: string;
+            /** array of role ids the member is assigned */
+            roles: snowflake[];
+            /** whether the user is muted in voice channels */
+            mute: boolean;
+            /** whether the user is deafened in voice channels */
+            deaf: boolean;
+        }
+        /** https://discord.com/developers/docs/resources/guild#modify-guild-member-json-params */
+        interface Modify {
+            /** value to set user's nickname to */
+            nick: string;
+            /** array of role ids the member is assigned */
+            roles: snowflake[];
+            /** whether the user is muted in voice channels. Will throw a 400 if the user is not in a voice channel */
+            mute: boolean;
+            /** whether the user is deafened in voice channels. Will throw a 400 if the user is not in a voice channel */
+            deaf: boolean;
+            /** id of channel to move user to (if they are connected to voice) */
+            channel_id: snowflake;
+            /** when the user's timeout will expire and the user will be able to communicate in the guild again (up to 28 days in the future), set to null to remove timeout */
+            communication_disabled_until?: timestamp;
+        }
+        /** https://discord.com/developers/docs/resources/guild#modify-current-member-json-params */
+        interface ModifyCurrent {
+            /** value to set user's nickname to */
+            nick?: string;
+        }
+        /** https://discord.com/developers/docs/resources/guild#get-guild-prune-count-query-string-params */
+        interface GetPruneCount {
+            /** number of days to count prune for (1-30) */
+            days: integer;
+            /** role(s) to include */
+            include_roles: string;
+        }
+        /** https://discord.com/developers/docs/resources/guild#begin-guild-prune-json-params */
+        interface BeginPrune {
+            /** number of days to prune (1-30) */
+            days: integer;
+            /** whether 'pruned' is returned, discouraged for large guilds */
+            compute_prune_count: boolean;
+            /** role(s) to include */
+            include_roles: snowflake[];
+        }
+    }
+    namespace Event {
+        /** https://discord.com/developers/docs/topics/gateway#guild-member-add-guild-member-add-extra-fields */
+        interface Add extends GuildMember {
+            /** id of the guild */
+            guild_id: snowflake;
+        }
+        /** https://discord.com/developers/docs/topics/gateway#guild-member-remove-guild-member-remove-event-fields */
+        interface Remove {
+            /** the id of the guild */
+            guild_id: snowflake;
+            /** the user who was removed */
+            user: User;
+        }
+        /** https://discord.com/developers/docs/topics/gateway#guild-member-update-guild-member-update-event-fields */
+        interface Update {
+            /** the id of the guild */
+            guild_id: snowflake;
+            /** user role ids */
+            roles: snowflake[];
+            /** the user */
+            user: User;
+            /** nickname of the user in the guild */
+            nick?: string;
+            /** the member's guild avatar hash */
+            avatar?: string;
+            /** when the user joined the guild */
+            joined_at?: timestamp;
+            /** when the user starting boosting the guild */
+            premium_since?: timestamp;
+            /** whether the user is deafened in voice channels */
+            deaf?: boolean;
+            /** whether the user is muted in voice channels */
+            mute?: boolean;
+            /** whether the user has not yet passed the guild's Membership Screening requirements */
+            pending?: boolean;
+        }
+        /** https://discord.com/developers/docs/topics/gateway#guild-members-chunk-guild-members-chunk-event-fields */
+        interface Chunk {
+            /** the id of the guild */
+            guild_id: snowflake;
+            /** set of guild members */
+            members: GuildMember[];
+            /** the chunk index in the expected chunks for this response (0 <= chunk_index < chunk_count) */
+            chunk_index: integer;
+            /** the total number of expected chunks for this response */
+            chunk_count: integer;
+            /** if passing an invalid id to REQUEST_GUILD_MEMBERS, it will be returned here */
+            not_found?: snowflake[];
+            /** if passing true to REQUEST_GUILD_MEMBERS, presences of the returned members will be here */
+            presences?: PresenceUpdateParams[];
+            /** the nonce used in the Guild Members Request */
+            nonce?: string;
+        }
+    }
 }
 declare module './gateway' {
     interface GatewayEvents {
         /** new user joined a guild */
-        GUILD_MEMBER_ADD: GuildMemberAddEvent;
+        GUILD_MEMBER_ADD: GuildMember.Event.Add;
         /** user was removed from a guild */
-        GUILD_MEMBER_REMOVE: GuildMemberRemoveEvent;
+        GUILD_MEMBER_REMOVE: GuildMember.Event.Remove;
         /** guild member was updated */
-        GUILD_MEMBER_UPDATE: GuildMemberUpdateEvent;
+        GUILD_MEMBER_UPDATE: GuildMember.Event.Update;
         /** response to Request Guild Members */
-        GUILD_MEMBERS_CHUNK: GuildMembersChunkEvent;
+        GUILD_MEMBERS_CHUNK: GuildMember.Event.Chunk;
     }
 }
-export interface ListGuildMembersOptions {
-    /** max number of members to return (1-1000) */
-    limit?: integer;
-    /** the highest user id in the previous page */
-    after?: snowflake;
-}
-export interface SearchGuildMembersOptions {
-    /** query string to match username(s) and nickname(s) against */
-    query: string;
-    /** max number of members to return (1-1000) */
-    limit?: integer;
-}
 declare module './internal' {
     interface Internal {
-        /** https://discord.com/developers/docs/resources/guild#get-guild-member */
+        /**
+         * Returns a guild member object for the specified user.
+         * @see https://discord.com/developers/docs/resources/guild#get-guild-member
+         */
         getGuildMember(guild_id: snowflake, user_id: snowflake): Promise<GuildMember>;
-        /** https://discord.com/developers/docs/resources/guild#list-guild-members */
-        listGuildMembers(guild_id: snowflake, options?: ListGuildMembersOptions): Promise<GuildMember[]>;
-        /** https://discord.com/developers/docs/resources/guild#search-guild-members */
-        searchGuildMembers(guild_id: snowflake, options: SearchGuildMembersOptions): Promise<GuildMember[]>;
+        /**
+         * Returns a list of guild member objects that are members of the guild.
+         * @see https://discord.com/developers/docs/resources/guild#list-guild-members
+         */
+        listGuildMembers(guild_id: snowflake, params?: GuildMember.Params.List): Promise<GuildMember[]>;
+        /**
+         * Returns a list of guild member objects whose username or nickname starts with a provided string.
+         * @see https://discord.com/developers/docs/resources/guild#search-guild-members
+         */
+        searchGuildMembers(guild_id: snowflake, params?: GuildMember.Params.Search): Promise<GuildMember[]>;
+        /**
+         * Adds a user to the guild, provided you have a valid oauth2 access token for the user with the guilds.join scope. Returns a 201 Created with the guild member as the body, or 204 No Content if the user is already a member of the guild. Fires a Guild Member Add Gateway event.
+         * @see https://discord.com/developers/docs/resources/guild#add-guild-member
+         */
+        addGuildMember(guild_id: snowflake, user_id: snowflake, params: GuildMember.Params.Add): Promise<void>;
+        /**
+         * Modify attributes of a guild member. Returns a 200 OK with the guild member as the body. Fires a Guild Member Update Gateway event. If the channel_id is set to null, this will force the target user to be disconnected from voice.
+         * @see https://discord.com/developers/docs/resources/guild#modify-guild-member
+         */
+        modifyGuildMember(guild_id: snowflake, user_id: snowflake, params: GuildMember.Params.Modify): Promise<void>;
+        /**
+         * Modifies the current member in a guild. Returns a 200 with the updated member object on success. Fires a Guild Member Update Gateway event.
+         * @see https://discord.com/developers/docs/resources/guild#modify-current-member
+         */
+        modifyCurrentMember(guild_id: snowflake, params: GuildMember.Params.ModifyCurrent): Promise<void>;
+        /**
+         * Adds a role to a guild member. Requires the MANAGE_ROLES permission. Returns a 204 empty response on success. Fires a Guild Member Update Gateway event.
+         * @see https://discord.com/developers/docs/resources/guild#add-guild-member-role
+         */
+        addGuildMemberRole(guild_id: snowflake, user_id: snowflake, role_id: snowflake): Promise<void>;
+        /**
+         * Removes a role from a guild member. Requires the MANAGE_ROLES permission. Returns a 204 empty response on success. Fires a Guild Member Update Gateway event.
+         * @see https://discord.com/developers/docs/resources/guild#remove-guild-member-role
+         */
+        removeGuildMemberRole(guild_id: snowflake, user_id: snowflake, role_id: snowflake): Promise<void>;
+        /**
+         * Remove a member from a guild. Requires KICK_MEMBERS permission. Returns a 204 empty response on success. Fires a Guild Member Remove Gateway event.
+         * @see https://discord.com/developers/docs/resources/guild#remove-guild-member
+         */
+        removeGuildMember(guild_id: snowflake, user_id: snowflake): Promise<void>;
+        /**
+         * Returns an object with one 'pruned' key indicating the number of members that would be removed in a prune operation. Requires the KICK_MEMBERS permission.
+         * @see https://discord.com/developers/docs/resources/guild#get-guild-prune-count
+         */
+        getGuildPruneCount(guild_id: snowflake, params?: GuildMember.Params.GetPruneCount): Promise<void>;
+        /**
+         * Begin a prune operation. Requires the KICK_MEMBERS permission. Returns an object with one 'pruned' key indicating the number of members that were removed in the prune operation. For large guilds it's recommended to set the compute_prune_count option to false, forcing 'pruned' to null. Fires multiple Guild Member Remove Gateway events.
+         * @see https://discord.com/developers/docs/resources/guild#begin-guild-prune
+         */
+        beginGuildPrune(guild_id: snowflake, params: GuildMember.Params.BeginPrune): Promise<void>;
     }
 }

package/lib/types/guild-scheduled-event.d.ts

@@ -0,0 +1,167 @@
+import { GuildMember, integer, snowflake, timestamp, User } from '.';
+/** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-structure */
+export interface GuildScheduledEvent {
+    /** the id of the scheduled event */
+    id: snowflake;
+    /** the guild id which the scheduled event belongs to */
+    guild_id: snowflake;
+    /** the channel id in which the scheduled event will be hosted, or null if scheduled entity type is EXTERNAL */
+    channel_id?: snowflake;
+    /** the id of the user that created the scheduled event * */
+    creator_id?: snowflake;
+    /** the name of the scheduled event (1-100 characters) */
+    name: string;
+    /** the description of the scheduled event (1-1000 characters) */
+    description?: string;
+    /** the time the scheduled event will start */
+    scheduled_start_time: timestamp;
+    /** the time the scheduled event will end, required if entity_type is EXTERNAL */
+    scheduled_end_time?: timestamp;
+    /** the privacy level of the scheduled event */
+    privacy_level: GuildScheduledEvent.PrivacyLevel;
+    /** the status of the scheduled event */
+    status: GuildScheduledEvent.Status;
+    /** the type of the scheduled event */
+    entity_type: GuildScheduledEvent.EntityType;
+    /** the id of an entity associated with a guild scheduled event */
+    entity_id?: snowflake;
+    /** additional metadata for the guild scheduled event */
+    entity_metadata?: GuildScheduledEvent.EntityMetadata;
+    /** the user that created the scheduled event */
+    creator?: User;
+    /** the number of users subscribed to the scheduled event */
+    user_count?: integer;
+}
+export declare namespace GuildScheduledEvent {
+    /** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-privacy-level */
+    enum PrivacyLevel {
+        /** the scheduled event is only accessible to guild members */
+        GUILD_ONLY = 2
+    }
+    /** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-types */
+    enum EntityType {
+        STAGE_INSTANCE = 1,
+        VOICE = 2,
+        EXTERNAL = 3
+    }
+    /** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-status */
+    enum Status {
+        SCHEDULED = 1,
+        ACTIVE = 2,
+        COMPLETED = 3,
+        CANCELLED = 4
+    }
+    /** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-metadata */
+    interface EntityMetadata {
+        /** location of the event (1-100 characters) */
+        location?: string;
+    }
+    /** https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild-query-string-params */
+    interface ListParams {
+        /** include number of users subscribed to each event */
+        with_user_count?: boolean;
+    }
+    /** https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event-json-params */
+    interface CreateParams {
+        /** the channel id of the scheduled event. */
+        channel_id?: snowflake;
+        /** the entity metadata of the scheduled event */
+        entity_metadata?: EntityMetadata;
+        /** the name of the scheduled event */
+        name: string;
+        /** the privacy level of the scheduled event */
+        privacy_level: PrivacyLevel;
+        /** the time to schedule the scheduled event */
+        scheduled_start_time: timestamp;
+        /** the time when the scheduled event is scheduled to end */
+        scheduled_end_time?: timestamp;
+        /** the description of the scheduled event */
+        description?: string;
+        /** the entity type of the scheduled event */
+        entity_type: EntityType;
+    }
+    /** https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-query-string-params */
+    interface GetParams {
+        /** include number of users subscribed to this event */
+        with_user_count?: boolean;
+    }
+    /** https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event-json-params */
+    interface ModifyParams {
+        /** the channel id of the scheduled event, set to null if changing entity type to EXTERNAL */
+        channel_id?: snowflake;
+        /** the entity metadata of the scheduled event */
+        entity_metadata?: EntityMetadata;
+        /** the name of the scheduled event */
+        name?: string;
+        /** the privacy level of the scheduled event */
+        privacy_level?: PrivacyLevel;
+        /** the time to schedule the scheduled event */
+        scheduled_start_time?: timestamp;
+        /** the time when the scheduled event is scheduled to end */
+        scheduled_end_time?: timestamp;
+        /** the description of the scheduled event */
+        description?: string;
+        /** the entity type of the scheduled event */
+        entity_type?: EntityType;
+        /** the status of the scheduled event */
+        status?: Status;
+    }
+}
+/** https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-user-object-guild-scheduled-event-user-structure */
+export interface GuildScheduledEventUser {
+    /** the scheduled event id which the user subscribed to */
+    guild_scheduled_event_id: snowflake;
+    /** user which subscribed to an event */
+    user: User;
+    /** guild member data for this user for the guild which this event belongs to, if any */
+    member?: GuildMember;
+}
+export declare namespace GuildScheduledEventUser {
+    /** https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users-query-string-params */
+    interface GetParams {
+        /** number of users to return (up to maximum 100) */
+        limit?: number;
+        /** include guild member data if it exists */
+        with_member?: boolean;
+        /** consider only users before given user id */
+        before?: snowflake;
+        /** consider only users after given user id */
+        after?: snowflake;
+    }
+}
+declare module './internal' {
+    interface Internal {
+        /**
+         * Returns a list of guild scheduled event objects for the given guild.
+         * @see https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild
+         */
+        listScheduledEventsforGuild(guildId: snowflake, params?: GuildScheduledEvent.ListParams): Promise<GuildScheduledEvent[]>;
+        /**
+         * Create a guild scheduled event in the guild. Returns a guild scheduled event object on success.
+         * @see https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event
+         */
+        createGuildScheduledEvent(guildId: snowflake, params: GuildScheduledEvent.CreateParams): Promise<GuildScheduledEvent>;
+        /**
+         * Get a guild scheduled event. Returns a guild scheduled event object on success.
+         * @see https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event
+         */
+        getGuildScheduledEvent(guildId: snowflake, eventId: snowflake, params?: GuildScheduledEvent.GetParams): Promise<GuildScheduledEvent>;
+        /**
+         * Modify a guild scheduled event. Returns the modified guild scheduled event object on success.
+         * @see https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event
+         */
+        modifyGuildScheduledEvent(guildId: snowflake, eventId: snowflake, params: GuildScheduledEvent.ModifyParams): Promise<GuildScheduledEvent>;
+        /**
+         * Delete a guild scheduled event. Returns a 204 on success.
+         * @see https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event
+         */
+        deleteGuildScheduledEvent(guildId: snowflake, eventId: snowflake): Promise<void>;
+        /**
+         * Get a list of guild scheduled event users subscribed to a guild scheduled event.
+         * Returns a list of guild scheduled event user objects on success.
+         * Guild member data, if it exists, is included if the with_member query parameter is set.
+         * @see https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users
+         */
+        getGuildScheduledEventUsers(guildId: snowflake, eventId: snowflake, params?: GuildScheduledEventUser.GetParams): Promise<GuildScheduledEventUser[]>;
+    }
+}

package/lib/types/guild-template.d.ts

@@ -24,3 +24,65 @@ export interface GuildTemplate {
     /** whether the template has unsynced changes */
     is_dirty?: boolean;
 }
+export declare namespace GuildTemplate {
+    /** https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template-json-params */
+    interface CreateGuildParams {
+        /** name of the guild (2-100 characters) */
+        name: string;
+        /** base64 128x128 image for the guild icon */
+        icon?: string;
+    }
+    /** https://discord.com/developers/docs/resources/guild-template#create-guild-template-json-params */
+    interface CreateParams {
+        /** name of the template (1-100 characters) */
+        name: string;
+        /** description for the template (0-120 characters) */
+        description?: string;
+    }
+    /** https://discord.com/developers/docs/resources/guild-template#modify-guild-template-json-params */
+    interface ModifyParams {
+        /** name of the template (1-100 characters) */
+        name?: string;
+        /** description for the template (0-120 characters) */
+        description?: string;
+    }
+}
+declare module './internal' {
+    interface Internal {
+        /**
+         * Returns a guild template object for the given code.
+         * @see https://discord.com/developers/docs/resources/guild-template#get-guild-template
+         */
+        getGuildTemplate(code: string): Promise<GuildTemplate>;
+        /**
+         * Create a new guild based on a template. Returns a guild object on success. Fires a Guild Create Gateway event.
+         * @see https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template
+         */
+        createGuildfromGuildTemplate(code: string, params: GuildTemplate.CreateGuildParams): Promise<Guild>;
+        /**
+         * Returns an array of guild template objects. Requires the MANAGE_GUILD permission.
+         * @see https://discord.com/developers/docs/resources/guild-template#get-guild-templates
+         */
+        getGuildTemplates(guild_id: snowflake): Promise<GuildTemplate[]>;
+        /**
+         * Creates a template for the guild. Requires the MANAGE_GUILD permission. Returns the created guild template object on success.
+         * @see https://discord.com/developers/docs/resources/guild-template#create-guild-template
+         */
+        createGuildTemplate(guild_id: snowflake, params: GuildTemplate.CreateParams): Promise<GuildTemplate>;
+        /**
+         * Syncs the template to the guild's current state. Requires the MANAGE_GUILD permission. Returns the guild template object on success.
+         * @see https://discord.com/developers/docs/resources/guild-template#sync-guild-template
+         */
+        syncGuildTemplate(guild_id: snowflake, code: string): Promise<GuildTemplate>;
+        /**
+         * Modifies the template's metadata. Requires the MANAGE_GUILD permission. Returns the guild template object on success.
+         * @see https://discord.com/developers/docs/resources/guild-template#modify-guild-template
+         */
+        modifyGuildTemplate(guild_id: snowflake, code: string, params: GuildTemplate.ModifyParams): Promise<GuildTemplate>;
+        /**
+         * Deletes the template. Requires the MANAGE_GUILD permission. Returns the deleted guild template object on success.
+         * @see https://discord.com/developers/docs/resources/guild-template#delete-guild-template
+         */
+        deleteGuildTemplate(guild_id: snowflake, code: string): Promise<GuildTemplate>;
+    }
+}