dressed
Version:
A sleek, serverless-ready Discord bot framework.
41 lines (40 loc) • 2.48 kB
TypeScript
import type { RESTGetAPIGuildScheduledEventQuery, RESTGetAPIGuildScheduledEventResult, RESTGetAPIGuildScheduledEventsQuery, RESTGetAPIGuildScheduledEventsResult, RESTGetAPIGuildScheduledEventUsersQuery, RESTGetAPIGuildScheduledEventUsersResult, RESTPatchAPIGuildScheduledEventJSONBody, RESTPatchAPIGuildScheduledEventResult, RESTPostAPIGuildScheduledEventJSONBody, RESTPostAPIGuildScheduledEventResult, Snowflake } from "discord-api-types/v10";
/**
* Returns a list of guild scheduled event objects for the given guild.
* @param guild The guild to get the scheduled events from
* @param options Optional parameters for the request
*/
export declare function listScheduledEvents(guild: Snowflake, options?: RESTGetAPIGuildScheduledEventsQuery): Promise<RESTGetAPIGuildScheduledEventsResult>;
/**
* Create a guild scheduled event in the guild.
* @param guild The guild to create the scheduled event in
* @param data The scheduled event data
*/
export declare function createScheduledEvent(guild: Snowflake, data: RESTPostAPIGuildScheduledEventJSONBody): Promise<RESTPostAPIGuildScheduledEventResult>;
/**
* Get a guild scheduled event.
* @param guild The guild to get the scheduled event in
* @param event The event to get
* @param options Optional parameters for the request
*/
export declare function getScheduledEvent(guild: Snowflake, event: Snowflake, options?: RESTGetAPIGuildScheduledEventQuery): Promise<RESTGetAPIGuildScheduledEventResult>;
/**
* Modify a guild scheduled event.
* @param guild The guild to modify the scheduled event in
* @param event The event to modify
* @param data The new scheduled event data
*/
export declare function modifyScheduledEvent(guild: Snowflake, event: Snowflake, data: RESTPatchAPIGuildScheduledEventJSONBody): Promise<RESTPatchAPIGuildScheduledEventResult>;
/**
* Delete a guild scheduled event.
* @param guild The guild to delete the scheduled event from
* @param event The event to delete
*/
export declare function deleteScheduledEvent(guild: Snowflake, event: Snowflake): Promise<void>;
/**
* Get a list of guild scheduled event users subscribed to a guild scheduled event.
* @param guild The guild to get the scheduled event in
* @param event The event to get from
* @param options Optional parameters for the request
*/
export declare function getScheduledEventUsers(guild: Snowflake, event: Snowflake, options?: RESTGetAPIGuildScheduledEventUsersQuery): Promise<RESTGetAPIGuildScheduledEventUsersResult>;