@koishijs/plugin-adapter-discord 2.0.0-rc.0 → 2.0.2

package/lib/types/role.d.ts

@@ -105,6 +105,51 @@ export interface Role {
     /** the tags this role has */
     tags?: RoleTags;
 }
+export declare namespace Role {
+    namespace Params {
+        /** https://discord.com/developers/docs/resources/guild#create-guild-role-json-params */
+        interface Create {
+            /** name of the role */
+            name: string;
+            /** bitwise value of the enabled/disabled permissions */
+            permissions: string;
+            /** RGB color value */
+            color: integer;
+            /** whether the role should be displayed separately in the sidebar */
+            hoist: boolean;
+            /** the role's icon image (if the guild has the ROLE_ICONS feature) */
+            icon: string;
+            /** the role's unicode emoji as a standard emoji (if the guild has the ROLE_ICONS feature) */
+            unicode_emoji: string;
+            /** whether the role should be mentionable */
+            mentionable: boolean;
+        }
+        /** https://discord.com/developers/docs/resources/guild#modify-guild-role-positions-json-params */
+        interface ModifyPositions {
+            /** role */
+            id: snowflake;
+            /** sorting position of the role */
+            position?: integer;
+        }
+        /** https://discord.com/developers/docs/resources/guild#modify-guild-role-json-params */
+        interface Modify {
+            /** name of the role */
+            name: string;
+            /** bitwise value of the enabled/disabled permissions */
+            permissions: string;
+            /** RGB color value */
+            color: integer;
+            /** whether the role should be displayed separately in the sidebar */
+            hoist: boolean;
+            /** the role's icon image (if the guild has the ROLE_ICONS feature) */
+            icon: string;
+            /** the role's unicode emoji as a standard emoji (if the guild has the ROLE_ICONS feature) */
+            unicode_emoji: string;
+            /** whether the role should be mentionable */
+            mentionable: boolean;
+        }
+    }
+}
 /** https://discord.com/developers/docs/topics/permissions#role-object-role-tags-structure */
 export interface RoleTags {
     /** the id of the bot this role belongs to */
@@ -145,3 +190,32 @@ declare module './gateway' {
         GUILD_ROLE_DELETE: GuildRoleDeleteEvent;
     }
 }
+declare module './internal' {
+    interface Internal {
+        /**
+         * Returns a list of role objects for the guild.
+         * @see https://discord.com/developers/docs/resources/guild#get-guild-roles
+         */
+        getGuildRoles(guild_id: snowflake): Promise<Role[]>;
+        /**
+         * Create a new role for the guild. Requires the MANAGE_ROLES permission. Returns the new role object on success. Fires a Guild Role Create Gateway event. All JSON params are optional.
+         * @see https://discord.com/developers/docs/resources/guild#create-guild-role
+         */
+        createGuildRole(guild_id: snowflake, param: Role.Params.Create): Promise<Role>;
+        /**
+         * Modify the positions of a set of role objects for the guild. Requires the MANAGE_ROLES permission. Returns a list of all of the guild's role objects on success. Fires multiple Guild Role Update Gateway events.
+         * @see https://discord.com/developers/docs/resources/guild#modify-guild-role-positions
+         */
+        modifyGuildRolePositions(guild_id: snowflake, param: Role.Params.ModifyPositions): Promise<Role[]>;
+        /**
+         * Modify a guild role. Requires the MANAGE_ROLES permission. Returns the updated role on success. Fires a Guild Role Update Gateway event.
+         * @see https://discord.com/developers/docs/resources/guild#modify-guild-role
+         */
+        modifyGuildRole(guild_id: snowflake, role_id: snowflake, param: Role.Params.Modify): Promise<Role>;
+        /**
+         * Delete a guild role. Requires the MANAGE_ROLES permission. Returns a 204 empty response on success. Fires a Guild Role Delete Gateway event.
+         * @see https://discord.com/developers/docs/resources/guild#delete-guild-role
+         */
+        deleteGuildRole(guild_id: snowflake, role_id: snowflake): Promise<void>;
+    }
+}

package/lib/types/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/stage-instance.d.ts

@@ -14,19 +14,65 @@ export interface StageInstance {
     /** Whether or not Stage Discovery is disabled */
     discoverable_disabled: boolean;
 }
-export interface StageInstanceCreateEvent extends StageInstance {
-}
-export interface StageInstanceDeleteEvent extends StageInstance {
-}
-export interface StageInstanceUpdateEvent extends StageInstance {
+export declare namespace StageInstance {
+    namespace Event {
+        interface Create extends StageInstance {
+        }
+        interface Delete extends StageInstance {
+        }
+        interface Update extends StageInstance {
+        }
+    }
+    namespace Params {
+        /** https://discord.com/developers/docs/resources/stage-instance#create-stage-instance-json-params */
+        interface Create {
+            /** The id of the Stage channel */
+            channel_id: snowflake;
+            /** The topic of the Stage instance (1-120 characters) */
+            topic: string;
+            /** The privacy level of the Stage instance (default GUILD_ONLY) */
+            privacy_level?: integer;
+        }
+        /** https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance-json-params */
+        interface Modify {
+            /** The topic of the Stage instance (1-120 characters) */
+            topic?: string;
+            /** The privacy level of the Stage instance */
+            privacy_level?: integer;
+        }
+    }
 }
 declare module './gateway' {
     interface GatewayEvents {
         /** stage instance was created */
-        STAGE_INSTANCE_CREATE: StageInstanceCreateEvent;
+        STAGE_INSTANCE_CREATE: StageInstance.Event.Create;
         /** stage instance was deleted or closed */
-        STAGE_INSTANCE_DELETE: StageInstanceDeleteEvent;
+        STAGE_INSTANCE_DELETE: StageInstance.Event.Delete;
         /** stage instance was updated */
-        STAGE_INSTANCE_UPDATE: StageInstanceUpdateEvent;
+        STAGE_INSTANCE_UPDATE: StageInstance.Event.Update;
+    }
+}
+declare module './internal' {
+    interface Internal {
+        /**
+         * Creates a new Stage instance associated to a Stage channel.
+         * @see https://discord.com/developers/docs/resources/stage-instance#create-stage-instance
+         */
+        createStageInstance(params: StageInstance.Params.Create): Promise<StageInstance>;
+        /**
+         * Gets the stage instance associated with the Stage channel, if it exists.
+         * @see https://discord.com/developers/docs/resources/stage-instance#get-stage-instance
+         */
+        getStageInstance(channel_id: snowflake): Promise<StageInstance>;
+        /**
+         * Updates fields of an existing Stage instance.
+         * @see https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance
+         */
+        modifyStageInstance(channel_id: snowflake, params: StageInstance.Params.Modify): Promise<StageInstance>;
+        /**
+         * Deletes the Stage instance.
+         * @see https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance
+         */
+        deleteStageInstance(channel_id: snowflake): Promise<void>;
     }
 }

package/lib/types/sticker.d.ts

@@ -14,9 +14,9 @@ export interface Sticker {
     /** Deprecated previously the sticker asset hash, now an empty string */
     asset: string;
     /** type of sticker */
-    type: integer;
+    type: Sticker.Type;
     /** type of sticker format */
-    format_type: integer;
+    format_type: Sticker.FormatType;
     /** whether this guild sticker can be used, may be false due to loss of Server Boosts */
     available?: boolean;
     /** id of the guild that owns this sticker */
@@ -26,55 +26,124 @@ export interface Sticker {
     /** the standard sticker's sort order within its pack */
     sort_value?: integer;
 }
-/** https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-types */
-export declare enum StickerType {
-    /** an official sticker in a pack, part of Nitro or in a removed purchasable pack */
-    STANDARD = 1,
-    /** a sticker uploaded to a Boosted guild for the guild's members */
-    GUILD = 2
-}
-/** https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types */
-export declare enum StickerFormatType {
-    PNG = 1,
-    APNG = 2,
-    LOTTIE = 3
-}
-/** https://discord.com/developers/docs/resources/sticker#sticker-item-object-sticker-item-structure */
-export interface StickerItem {
-    /** id of the sticker */
-    id: snowflake;
-    /** name of the sticker */
-    name: string;
-    /** type of sticker format */
-    format_type: integer;
-}
-/** https://discord.com/developers/docs/resources/sticker#sticker-pack-object-sticker-pack-structure */
-export interface StickerPack {
-    /** id of the sticker pack */
-    id: snowflake;
-    /** the stickers in the pack */
-    stickers: Sticker[];
-    /** name of the sticker pack */
-    name: string;
-    /** id of the pack's SKU */
-    sku_id: snowflake;
-    /** id of a sticker in the pack which is shown as the pack's icon */
-    cover_sticker_id?: snowflake;
-    /** description of the sticker pack */
-    description: string;
-    /** id of the sticker pack's banner image */
-    banner_asset_id: snowflake;
-}
-/** https://discord.com/developers/docs/topics/gateway#guild-stickers-update-guild-stickers-update-event-fields */
-export interface GuildStickersUpdateEvent {
-    /** id of the guild */
-    guild_id: snowflake;
-    /** array of stickers */
-    stickers: Sticker[];
+export declare namespace Sticker {
+    /** https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-types */
+    enum Type {
+        /** an official sticker in a pack, part of Nitro or in a removed purchasable pack */
+        STANDARD = 1,
+        /** a sticker uploaded to a Boosted guild for the guild's members */
+        GUILD = 2
+    }
+    /** https://discord.com/developers/docs/resources/sticker#sticker-object-sticker-format-types */
+    enum FormatType {
+        PNG = 1,
+        APNG = 2,
+        LOTTIE = 3
+    }
+    /** https://discord.com/developers/docs/resources/sticker#sticker-item-object-sticker-item-structure */
+    interface Item {
+        /** id of the sticker */
+        id: snowflake;
+        /** name of the sticker */
+        name: string;
+        /** type of sticker format */
+        format_type: FormatType;
+    }
+    /** https://discord.com/developers/docs/resources/sticker#sticker-pack-object-sticker-pack-structure */
+    interface Pack {
+        /** id of the sticker pack */
+        id: snowflake;
+        /** the stickers in the pack */
+        stickers: Sticker[];
+        /** name of the sticker pack */
+        name: string;
+        /** id of the pack's SKU */
+        sku_id: snowflake;
+        /** id of a sticker in the pack which is shown as the pack's icon */
+        cover_sticker_id?: snowflake;
+        /** description of the sticker pack */
+        description: string;
+        /** id of the sticker pack's banner image */
+        banner_asset_id: snowflake;
+    }
+    namespace Event {
+        /** https://discord.com/developers/docs/topics/gateway#guild-stickers-update-guild-stickers-update-event-fields */
+        interface Update {
+            /** id of the guild */
+            guild_id: snowflake;
+            /** array of stickers */
+            stickers: Sticker[];
+        }
+    }
+    /** https://discord.com/developers/docs/resources/sticker#list-nitro-sticker-packs-response-structure */
+    interface PackResult {
+        sticker_packs: Pack[];
+    }
+    namespace Params {
+        /** https://discord.com/developers/docs/resources/sticker#create-guild-sticker-form-params */
+        interface Create {
+            /** name of the sticker (2-30 characters) */
+            name: string;
+            /** description of the sticker (empty or 2-100 characters) */
+            description: string;
+            /** autocomplete/suggestion tags for the sticker (max 200 characters) */
+            tags: string;
+            /** the sticker file to upload, must be a PNG, APNG, or Lottie JSON file, max 500 KB */
+            file: any;
+        }
+        /** https://discord.com/developers/docs/resources/sticker#modify-guild-sticker-json-params */
+        interface Modify {
+            /** name of the sticker (2-30 characters) */
+            name: string;
+            /** description of the sticker (2-100 characters) */
+            description?: string;
+            /** autocomplete/suggestion tags for the sticker (max 200 characters) */
+            tags: string;
+        }
+    }
 }
 declare module './gateway' {
     interface GatewayEvents {
         /** guild stickers were updated */
-        GUILD_STICKERS_UPDATE: GuildStickersUpdateEvent;
+        GUILD_STICKERS_UPDATE: Sticker.Event.Update;
+    }
+}
+declare module './internal' {
+    interface Internal {
+        /**
+         * Returns a sticker object for the given sticker ID.
+         * @see https://discord.com/developers/docs/resources/sticker#get-sticker
+         */
+        getSticker(sticker_id: snowflake): Promise<Sticker>;
+        /**
+         * Returns the list of sticker packs available to Nitro subscribers.
+         * @see https://discord.com/developers/docs/resources/sticker#list-nitro-sticker-packs
+         */
+        listNitroStickerPacks(): Promise<Sticker.PackResult>;
+        /**
+         * Returns an array of sticker objects for the given guild. Includes user fields if the bot has the MANAGE_EMOJIS_AND_STICKERS permission.
+         * @see https://discord.com/developers/docs/resources/sticker#list-guild-stickers
+         */
+        listGuildStickers(guild_id: snowflake): Promise<Sticker[]>;
+        /**
+         * Returns a sticker object for the given guild and sticker IDs. Includes the user field if the bot has the MANAGE_EMOJIS_AND_STICKERS permission.
+         * @see https://discord.com/developers/docs/resources/sticker#get-guild-sticker
+         */
+        getGuildSticker(guild_id: snowflake, sticker_id: snowflake): Promise<Sticker>;
+        /**
+         * Create a new sticker for the guild. Send a multipart/form-data body. Requires the MANAGE_EMOJIS_AND_STICKERS permission. Returns the new sticker object on success.
+         * @see https://discord.com/developers/docs/resources/sticker#create-guild-sticker
+         */
+        createGuildSticker(guild_id: snowflake, params: Sticker.Params.Create): Promise<Sticker>;
+        /**
+         * Modify the given sticker. Requires the MANAGE_EMOJIS_AND_STICKERS permission. Returns the updated sticker object on success.
+         * @see https://discord.com/developers/docs/resources/sticker#modify-guild-sticker
+         */
+        modifyGuildSticker(guild_id: snowflake, sticker_id: snowflake, params: Sticker.Params.Modify): Promise<Sticker>;
+        /**
+         * Delete the given sticker. Requires the MANAGE_EMOJIS_AND_STICKERS permission. Returns 204 No Content on success.
+         * @see https://discord.com/developers/docs/resources/sticker#delete-guild-sticker
+         */
+        deleteGuildSticker(guild_id: snowflake, sticker_id: snowflake): Promise<void>;
     }
 }