snowtransfer 0.18.0 → 0.19.0

package/dist/methods/Guild.d.ts

@@ -0,0 +1,722 @@
+import type { RequestHandler } from "../RequestHandler";
+import type { APIGuildMember, APIGuildWidget, RESTDeleteAPIGuildBanResult, RESTDeleteAPIGuildIntegrationResult, RESTDeleteAPIGuildMemberResult, RESTDeleteAPIGuildMemberRoleResult, RESTDeleteAPIGuildRoleResult, RESTGetAPIGuildBanResult, RESTGetAPIGuildBansQuery, RESTGetAPIGuildBansResult, RESTGetAPIGuildChannelsResult, RESTGetAPIGuildIntegrationsResult, RESTGetAPIGuildInvitesResult, RESTGetAPIGuildMemberResult, RESTGetAPIGuildMembersQuery, RESTGetAPIGuildMembersResult, RESTGetAPIGuildMembersSearchQuery, RESTGetAPIGuildMembersSearchResult, RESTGetAPIGuildMessagesSearchQuery, RESTGetAPIGuildMessagesSearchResult, RESTGetAPIGuildPreviewResult, RESTGetAPIGuildPruneCountQuery, RESTGetAPIGuildPruneCountResult, RESTGetAPIGuildResult, RESTGetAPIGuildRolesResult, RESTGetAPIGuildThreadsResult, RESTGetAPIGuildVanityUrlResult, RESTGetAPIGuildVoiceRegionsResult, RESTGetAPIGuildWelcomeScreenResult, RESTGetAPIGuildWidgetSettingsResult, RESTPatchAPICurrentGuildMemberJSONBody, RESTPatchAPIGuildChannelPositionsJSONBody, RESTPatchAPIGuildChannelPositionsResult, RESTPatchAPIGuildJSONBody, RESTPatchAPIGuildMemberJSONBody, RESTPatchAPIGuildMemberResult, RESTPatchAPIGuildResult, RESTPatchAPIGuildRoleJSONBody, RESTPatchAPIGuildRolePositionsJSONBody, RESTPatchAPIGuildRolePositionsResult, RESTPatchAPIGuildRoleResult, RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody, RESTPatchAPIGuildVoiceStateCurrentMemberResult, RESTPatchAPIGuildVoiceStateUserJSONBody, RESTPatchAPIGuildVoiceStateUserResult, RESTPatchAPIGuildWelcomeScreenJSONBody, RESTPatchAPIGuildWelcomeScreenResult, RESTPatchAPIGuildWidgetSettingsJSONBody, RESTPatchAPIGuildWidgetSettingsResult, RESTPostAPIGuildChannelJSONBody, RESTPostAPIGuildChannelResult, RESTPostAPIGuildPruneJSONBody, RESTPostAPIGuildPruneResult, RESTPostAPIGuildRoleJSONBody, RESTPostAPIGuildRoleResult, RESTPutAPIGuildBanJSONBody, RESTPutAPIGuildBanResult, RESTPutAPIGuildMemberJSONBody, RESTPutAPIGuildMemberResult, RESTPutAPIGuildMemberRoleResult } from "discord-api-types/v10";
+/**
+ * Methods for interacting with Guilds
+ * @since 0.1.0
+ */
+declare class GuildMethods {
+    readonly requestHandler: RequestHandler;
+    /**
+     * Create a new Guild Method Handler
+     *
+     * Usually SnowTransfer creates a method handler for you, this is here for completion
+     *
+     * You can access the methods listed via `client.guild.method`, where `client` is an initialized SnowTransfer instance
+     * @param requestHandler request handler that calls the rest api
+     */
+    constructor(requestHandler: RequestHandler);
+    /**
+     * Get a guild via Id
+     *
+     * CurrentUser must be a member of the guild
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @param withCounts when true, will return approximate member and presence counts for the guild
+     * @returns [Guild object](https://discord.com/developers/docs/resources/guild#guild-object)
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const guild = await client.guild.getGuild("guild id")
+     */
+    getGuild(guildId: string, withCounts?: boolean): Promise<RESTGetAPIGuildResult>;
+    /**
+     * Gets a guild's preview. If the CurrentUser is not in the guild, the guild must be lurkable
+     * @since 0.3.0
+     * @param guildId Id of the guild
+     * @returns [Guild preview](https://discord.com/developers/docs/resources/guild#guild-preview-object)
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const guildPreview = await client.guild.getGuildPreview("guild id")
+     */
+    getGuildPreview(guildId: string): Promise<RESTGetAPIGuildPreviewResult>;
+    /**
+     * Update a guild
+     * @since 0.18.0
+     * @param guildId Id of the guild
+     * @param data Updated guild data
+     * @param reason Reason for updating the guild
+     * @returns [Guild object](https://discord.com/developers/docs/resources/guild#guild-object)
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_GUILD       | always    |
+     *
+     * @example
+     * // Update the name of a guild to "Nice Guild"
+     * const client = new SnowTransfer("TOKEN")
+     * const guildData = {
+     * 	name: "Nice Guild"
+     * }
+     * client.guild.editGuild("guild Id", guildData)
+     */
+    editGuild(guildId: string, data: RESTPatchAPIGuildJSONBody, reason?: string): Promise<RESTPatchAPIGuildResult>;
+    /**
+     * Get a list of all channels for a guild. Does not include threads
+     *
+     * CurrentUser must be a member of the guild
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @returns list of [channels](https://discord.com/developers/docs/resources/channel#channel-object-channel-structure)
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const channels = await client.guild.getGuildChannels("guild id")
+     */
+    getGuildChannels(guildId: string): Promise<RESTGetAPIGuildChannelsResult>;
+    /**
+     * Create a channel within a guild
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @param data channel properties
+     * @param reason Reason for creating the channel
+     * @returns [channel object](https://discord.com/developers/docs/resources/channel#channel-object-channel-structure)
+     *
+     * | Permissions needed | Condition                                                       |
+     * |--------------------|-----------------------------------------------------------------|
+     * | MANAGE_CHANNELS    | always                                                          |
+     * | ADMINISTRATOR      | setting MANAGE_ROLES in permission_overwrites                   |
+     * | *                  | if setting * permission in overwrites where * is any permission |
+     *
+     * @example
+     * // Creates a guild voice channel with the name "nice voice channel" and with permission connect denied for the @ everyone role
+     * const client = new SnowTransfer("TOKEN")
+     * const channelData = \{
+     * 	name: "nice voice channel",
+     * 	type: 2,
+     * 	permission_overwrites: [\{ id: "guild id", type: 0, allow: "0" deny: (BigInt(1) << BigInt(20)).toString() \}]
+     * \}
+     * const channel = await client.guild.createGuildChannel("guild id", channelData)
+     */
+    createGuildChannel(guildId: string, data: RESTPostAPIGuildChannelJSONBody, reason?: string): Promise<RESTPostAPIGuildChannelResult>;
+    /**
+     * Batch update the positions of channels. Only those being moved needs to be included here
+     * @since 0.18.0
+     * @param guildId Id of the guild
+     * @param data Positional data to send
+     * @param reason Reason for updating the channels' positions
+     * @returns Resolves the Promise on successful execution
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_CHANNELS    | always    |
+     *
+     * @example
+     * // Sets the position of a channel to 2 under a category channel
+     * const client = new SnowTransfer("TOKEN")
+     * client.guild.editChannelPositions("guild id", [{ id: "channel id", position: 2, parent_id: "category id" }], "they looked out of order")
+     */
+    editChannelPositions(guildId: string, data: RESTPatchAPIGuildChannelPositionsJSONBody, reason?: string): Promise<RESTPatchAPIGuildChannelPositionsResult>;
+    /**
+     * Returns all active threads in the guild, including public and private threads. Threads are ordered by their `id`, in descending order
+     * @since 0.3.0
+     * @param guildId Id of the guild
+     * @returns All active threads and member objects of the CurrentUser that the CurrentUser has access to.
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const threads = await client.guild.listActiveThreads("guild id")
+     */
+    listActiveThreads(guildId: string): Promise<RESTGetAPIGuildThreadsResult>;
+    /**
+     * Get a guild member via Id
+     *
+     * CurrentUser must be a member of the guild
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @param memberId Id of the guild member
+     * @returns [guild member](https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-structure)
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const member = await client.guild.getGuildMember("guild id", "member id")
+     */
+    getGuildMember(guildId: string, memberId: string): Promise<RESTGetAPIGuildMemberResult>;
+    /**
+     * Get a list of guild members
+     *
+     * CurrentUser must be a member of the guild
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @param options query data
+     * @returns list of [guild members](https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-structure)
+     *
+     * | Intents       |
+     * |---------------|
+     * | GUILD_MEMBERS |
+     *
+     * @example
+     * // Gets 10 members from a guild
+     * const client = new SnowTransfer("TOKEN")
+     * const members = await client.guild.getGuildMembers("guild id", { limit: 10 })
+     */
+    getGuildMembers(guildId: string, options?: RESTGetAPIGuildMembersQuery): Promise<RESTGetAPIGuildMembersResult>;
+    /**
+     * Get a list of guild members that match a query
+     * @since 0.3.0
+     * @param guildId Id of the guild
+     * @param options query data
+     * @returns list of [guild members](https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-structure)
+     *
+     * @example
+     * // Gets all members with the username "Wolke"
+     * const client = new SnowTransfer("TOKEN")
+     * const members = await client.guild.searchGuildMembers("guild id", { query: "Wolke" })
+     */
+    searchGuildMembers(guildId: string, options: RESTGetAPIGuildMembersSearchQuery): Promise<RESTGetAPIGuildMembersSearchResult>;
+    /**
+     * Add a guild member to a guild via oauth2 access token
+     *
+     * CurrentUser must be a member of the guild
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @param memberId Id of the guild member
+     * @param data object containing the needed request data
+     * @returns [guild member](https://discord.com/developers/docs/resources/guild#guild-member-object-guild-member-structure) or void if the member is already in the guild
+     *
+     * | Permissions needed    | Condition |
+     * |-----------------------|-----------|
+     * | CREATE_INSTANT_INVITE | always    |
+     *
+     * | OAUTH2 Scopes |
+     * |---------------|
+     * | guilds.join   |
+     *
+     * @example
+     * // add a user to a server
+     * const client = new SnowTransfer("TOKEN")
+     * const memberData = {
+     * 	access_token: "access token of a user with the guilds.join scope"
+     * }
+     * client.guild.addGuildMember("guildId", "memberId", memberData)
+     */
+    addGuildMember(guildId: string, memberId: string, data: RESTPutAPIGuildMemberJSONBody): Promise<RESTPutAPIGuildMemberResult>;
+    /**
+     * Update properties of a guild member
+     * @since 0.18.0
+     * @param guildId Id of the guild
+     * @param memberId Id of the guild member
+     * @param data Updated properties
+     * @param reason Reason for updating the guild member
+     * @returns Resolves the Promise on successful execution
+     *
+     * | Permissions needed | Condition    |
+     * |--------------------|--------------|
+     * | MANAGE_NICKNAMES   | Nick Updates |
+     * | MANAGE_ROLES       | Role Updates |
+     * | MUTE_MEMBERS       | Mute Updates |
+     * | DEAFEN_MEMBERS     | Deaf Updates |
+     * | MOVE_MEMBERS       | Voice Move   |
+     * | CONNECT						| Voice Move   |
+     * | MODERATE_MEMBERS   | Timeouts     |
+     *
+     * @example
+     * // Reset the nickname of a guild member
+     * const client = new SnowTransfer("TOKEN")
+     * const memberData = {
+     * 	nick: "" // You can reset nicknames by providing an empty string as the value of data.nick
+     * }
+     * const member = await client.guild.editGuildMember("guild Id", "memberId", memberData)
+     */
+    editGuildMember(guildId: string, memberId: string, data: RESTPatchAPIGuildMemberJSONBody, reason?: string): Promise<RESTPatchAPIGuildMemberResult>;
+    /**
+     * Update the nick of the CurrentMember
+     * @since 0.18.0
+     * @param guildId Id of the guild
+     * @param data Data to update self with
+     * @param reason Reason for updating self
+     * @returns Resolves the Promise on successful execution
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | CHANGE_NICKNAME    | always    |
+     *
+     * @example
+     * // change nick of bot to "Nice Nick"
+     * const client = new SnowTransfer("TOKEN")
+     * const nickData = {
+     * 	nick: "Nice Nick"
+     * }
+     * client.guild.editSelf("guildId", nickData)
+     */
+    editSelf(guildId: string, data: RESTPatchAPICurrentGuildMemberJSONBody, reason?: string): Promise<APIGuildMember>;
+    /**
+     * Add a role to a guild member
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @param memberId Id of the guild member
+     * @param roleId Id of the role
+     * @param reason The reason for the role to be added
+     * @returns Resolves the Promise on successful execution
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_ROLES       | always    |
+     *
+     * @example
+     * // add a role to a member with a reason of "I want to add a role"
+     * const client = new SnowTransfer("TOKEN")
+     * client.guild.addGuildMemberRole("guildId", "memberId", "roleId", "I want to add a role")
+     */
+    addGuildMemberRole(guildId: string, memberId: string, roleId: string, reason?: string): Promise<RESTPutAPIGuildMemberRoleResult>;
+    /**
+     * Remove a role from a guild member
+     * @since 0.18.0
+     * @param guildId Id of the guild
+     * @param memberId Id of the guild member
+     * @param roleId Id of the role
+     * @param reason The reason for the role to be removed
+     * @returns Resolves the Promise on successful execution
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_ROLES       | always    |
+     *
+     * @example
+     * // remove a role from a member with a reason of "I want to remove a role"
+     * const client = new SnowTransfer("TOKEN")
+     * client.guild.deleteGuildMemberRole("guildId", "memberId", "roleId", "I want to remove a role")
+     */
+    deleteGuildMemberRole(guildId: string, memberId: string, roleId: string, reason?: string): Promise<RESTDeleteAPIGuildMemberRoleResult>;
+    /**
+     * Remove a guild member (aka kick them)
+     * @since 0.18.0
+     * @param guildId Id of the guild
+     * @param memberId Id of the guild member
+     * @param reason Reason for kicking the member
+     * @returns Resolves the Promise on successful execution
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | KICK_MEMBERS       | always    |
+     *
+     * @example
+     * // Kick a member with a reason of "spam"
+     * const client = new SnowTransfer("TOKEN")
+     * client.guild.deleteGuildMember("guild Id", "memberId", "spam")
+     */
+    deleteGuildMember(guildId: string, memberId: string, reason?: string): Promise<RESTDeleteAPIGuildMemberResult>;
+    /**
+     * Get bans of a guild
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @param options Query string options
+     * @returns List of [bans](https://discord.com/developers/docs/resources/guild#ban-object-ban-structure)
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | BAN_MEMBERS        | always    |
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const bans = await client.guild.getGuildBans("guildId")
+     */
+    getGuildBans(guildId: string, options?: RESTGetAPIGuildBansQuery): Promise<RESTGetAPIGuildBansResult>;
+    /**
+     * Get a specific ban of a guild member
+     * @since 0.4.2
+     * @param guildId Id of the guild
+     * @param memberId Id of the member
+     * @returns [ban](https://discord.com/developers/docs/resources/guild#ban-object-ban-structure) object
+     *
+     * @throws a `DiscordAPIError` if the member is not banned
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | BAN_MEMBERS        | always    |
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const ban = await client.guild.getGuildBan("guildId", "memberId")
+     */
+    getGuildBan(guildId: string, memberId: string): Promise<RESTGetAPIGuildBanResult>;
+    /**
+     * Ban a guild member
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @param memberId Id of the guild member
+     * @param data object with delete_message_days property
+     * @param reason Reason for banning the member
+     * @returns Resolves the Promise on successful execution
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | BAN_MEMBERS        | always    |
+     *
+     * @example
+     * // Ban a user with a reason and delete the last 2 days of their messages
+     * const client = new SnowTransfer("TOKEN")
+     * const banData = {
+     * 	delete_message_days: 2
+     * }
+     * client.guild.createGuildBan("guild Id", "memberId", banData, "Memes were not good enough")
+     */
+    createGuildBan(guildId: string, memberId: string, data?: RESTPutAPIGuildBanJSONBody, reason?: string): Promise<RESTPutAPIGuildBanResult>;
+    /**
+     * Remove a ban of a user
+     * @since 0.18.0
+     * @param guildId Id of the guild
+     * @param memberId Id of the guild member
+     * @param reason Reason for removing the ban
+     * @returns Resolves the Promise on successful execution
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | BAN_MEMBERS        | always    |
+     *
+     * @example
+     * // Remove a ban of a user with a reason
+     * const client = new SnowTransfer("TOKEN")
+     * client.guild.deleteGuildBan("guildId", "memberId", "This guy was cool")
+     */
+    deleteGuildBan(guildId: string, memberId: string, reason?: string): Promise<RESTDeleteAPIGuildBanResult>;
+    /**
+     * Get a list of roles for a guild
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @returns array of [roles](https://discord.com/developers/docs/topics/permissions#role-object)
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_ROLES       | always    |
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const roles = await client.guild.getGuildRoles("guildId")
+     */
+    getGuildRoles(guildId: string): Promise<RESTGetAPIGuildRolesResult>;
+    /**
+     * Create a new Role
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @param data data with role properties
+     * @param reason Reason for creating the role
+     * @returns [role](https://discord.com/developers/docs/resources/channel#channel-object-channel-structure)
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_ROLES       | always    |
+     *
+     * @example
+     * // Create a role with the name "Nice Role" and a color of a soft blue
+     * const client = new SnowTransfer("TOKEN")
+     * const roleData = {
+     * 	name: "Nice Role",
+     * 	color: 0x7c7cf8
+     * }
+     * client.guild.createGuildRole("guild Id", roleData)
+     */
+    createGuildRole(guildId: string, data?: RESTPostAPIGuildRoleJSONBody, reason?: string): Promise<RESTPostAPIGuildRoleResult>;
+    /**
+     * Modify the positions of roles
+     * @since 0.18.0
+     * @param guildId Id of the guild
+     * @param data Role data to update
+     * @param reason Reason for moving the roles
+     * @returns array of [roles](https://discord.com/developers/docs/topics/permissions#role-object)
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_ROLES       | always    |
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const roles = await client.guild.editGuildRolePositions("guildId", [{ id: "guild id", position: 1 }, { id: "role id 2", position: 2 }])
+     */
+    editGuildRolePositions(guildId: string, data: RESTPatchAPIGuildRolePositionsJSONBody, reason?: string): Promise<RESTPatchAPIGuildRolePositionsResult>;
+    /**
+     * Update a guild role
+     * @since 0.18.0
+     * @param guildId Id of the guild
+     * @param roleId Id of the role
+     * @param data updated properties of the role
+     * @param reason Reason for updating the role
+     * @returns [Updated Role](https://discord.com/developers/docs/topics/permissions#role-object)
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_ROLES       | always    |
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const roleData = {
+     * 	name: "Nicer Role",
+     * }
+     * client.guild.editGuildRole("guildId", "roleId", roleData)
+     */
+    editGuildRole(guildId: string, roleId: string, data: RESTPatchAPIGuildRoleJSONBody, reason?: string): Promise<RESTPatchAPIGuildRoleResult>;
+    /**
+     * Delete a role from the guild
+     * @since 0.18.0
+     * @param guildId Id of the guild
+     * @param roleId Id of the role
+     * @param reason Reason for deleting the role
+     * @returns Resolves the Promise on successful execution
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_ROLES       | always    |
+     *
+     * @example
+     * // Deletes a role with a reason "This role is too cool"
+     * const client = new SnowTransfer("TOKEN")
+     * client.guild.deleteGuildRole("guildId", "roleId", "This role is too cool")
+     */
+    deleteGuildRole(guildId: string, roleId: string, reason?: string): Promise<RESTDeleteAPIGuildRoleResult>;
+    /**
+     * Get the amount of members that would be pruned when a prune with the passed amount of days would be started
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @param options Object with prune data
+     * @returns Object with a "pruned" key indicating the amount of members that would be pruned
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | KICK_MEMBERS       | always    |
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const data = await client.guild.getGuildPruneCount("guildId", { days: 7 })
+     */
+    getGuildPruneCount(guildId: string, options?: RESTGetAPIGuildPruneCountQuery): Promise<RESTGetAPIGuildPruneCountResult>;
+    /**
+     * Start a prune
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @param data Object with prune data
+     * @param reason Reason for starting the prune
+     * @returns Object with a "pruned" key indicating the amount of members that were pruned
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | KICK_MEMBERS       | always    |
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const data = await client.guild.startGuildPrune("guildId", { days: 7 })
+     */
+    startGuildPrune(guildId: string, data: RESTPostAPIGuildPruneJSONBody & {
+        compute_prune_count: true;
+    }, reason?: string): Promise<RESTPostAPIGuildPruneResult & {
+        pruned: number;
+    }>;
+    startGuildPrune(guildId: string, data: RESTPostAPIGuildPruneJSONBody & {
+        compute_prune_count: false;
+    }, reason?: string): Promise<RESTPostAPIGuildPruneResult & {
+        pruned: null;
+    }>;
+    /**
+     * Get a list of voice regions for the guild, includes vip-regions unlike voice.getVoiceRegions
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @returns List of [voice regions](https://discord.com/developers/docs/resources/voice#voice-region-object)
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const regions = await client.guild.getGuildVoiceRegions("guildId")
+     */
+    getGuildVoiceRegions(guildId: string): Promise<RESTGetAPIGuildVoiceRegionsResult>;
+    /**
+     * Get invites for a guild
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @returns List of [invites](https://discord.com/developers/docs/resources/invite#invite-object) (with metadata)
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_GUILD       | always    |
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const invites = await client.guild.getGuildInvites("guildId")
+     */
+    getGuildInvites(guildId: string): Promise<RESTGetAPIGuildInvitesResult>;
+    /**
+     * Get integrations for a guild
+     * @since 0.1.0
+     * @param guildId Id of the guild
+     * @returns List of [integration objects](https://discord.com/developers/docs/resources/guild#integration-object)
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_GUILD       | always    |
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const integrations = await client.guild.getGuildIntegrations("guildId")
+     */
+    getGuildIntegrations(guildId: string): Promise<RESTGetAPIGuildIntegrationsResult>;
+    /**
+     * Delete a guild integration
+     * @since 0.18.0
+     * @param guildId Id of the guild
+     * @param integrationId Id of the integration
+     * @param reason Reason for removing the integration
+     * @returns Resolves the Promise on successful execution
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_GUILD       | always    |
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * await client.guild.deleteGuildIntegration("guildId", "integrationId", "Didn't need anymore")
+     */
+    deleteGuildIntegration(guildId: string, integrationId: string, reason?: string): Promise<RESTDeleteAPIGuildIntegrationResult>;
+    /**
+     * Get a guild widget settings object
+     * @since 0.3.0
+     * @param guildId Id of the guild
+     * @returns [Guild Widget settings](https://discord.com/developers/docs/resources/guild#guild-widget-settings-object-guild-widget-settings-structure)
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_GUILD       | always    |
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const widgetSettings = await client.guild.getGuildWidgetSettings("guildId")
+     */
+    getGuildWidgetSettings(guildId: string): Promise<RESTGetAPIGuildWidgetSettingsResult>;
+    /**
+     * Update a guild widget settings object
+     * @since 0.18.0
+     * @param guildId Id of the guild
+     * @param data widget settings
+     * @param reason Reason for updating the guild widget settings
+     * @returns Updated [Guild Widget settings](https://discord.com/developers/docs/resources/guild#guild-widget-settings-object-guild-widget-settings-structure)
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_GUILD       | always    |
+     *
+     * @example
+     * // Sets a widget as disabled
+     * const client = new SnowTransfer("TOKEN")
+     * const widgetSettings = await client.guild.editGuildWidgetSettings("guildId", { enabled: false })
+     */
+    editGuildWidgetSettings(guildId: string, data: Partial<RESTPatchAPIGuildWidgetSettingsJSONBody>, reason?: string): Promise<RESTPatchAPIGuildWidgetSettingsResult>;
+    /**
+     * Gets a guild widget object
+     * @since 0.3.0
+     * @param guildId Id of the guild
+     * @returns [Guild Widget](https://discord.com/developers/docs/resources/guild#guild-widget-object)
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const widget = await client.guild.getGuildWidget("guildId")
+     */
+    getGuildWidget(guildId: string): Promise<APIGuildWidget>;
+    /**
+     * Get a guild's vanity URL code
+     * @since 0.3.0
+     * @param guildId Id of the guild
+     * @returns partial [invite object](https://discord.com/developers/docs/resources/guild#get-guild-vanity-url-example-partial-invite-object)
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_GUILD       | always    |
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const vanityUrl = await client.guild.getGuildVanityUrl("guildId")
+     */
+    getGuildVanityURL(guildId: string): Promise<RESTGetAPIGuildVanityUrlResult>;
+    /**
+     * Get a guild's welcome screen object
+     * @since 0.3.0
+     * @param guildId Id of the guild
+     * @returns [Guild Welcome Screen](https://discord.com/developers/docs/resources/guild#welcome-screen-object)
+     *
+     * | Permissions needed | Condition                            |
+     * |--------------------|--------------------------------------|
+     * | MANAGE_GUILD       | if the welcome screen is not enabled |
+     *
+     * @example
+     * const client = new SnowTransfer("TOKEN")
+     * const welcomeScreen = await client.guild.getGuildWelcomeScreen("guildId")
+     */
+    getGuildWelcomeScreen(guildId: string): Promise<RESTGetAPIGuildWelcomeScreenResult>;
+    /**
+     * Update a guild welcome screen object
+     * @since 0.18.0
+     * @param guildId Id of guild
+     * @param data Welcome screen data
+     * @param reason Reason for editing the welcome screen
+     * @returns [Guild Welcome Screen](https://discord.com/developers/docs/resources/guild#welcome-screen-object)
+     *
+     * | Permissions needed | Condition |
+     * |--------------------|-----------|
+     * | MANAGE_GUILD       | always    |
+     *
+     * @example
+     * // Disabled the welcome screen
+     * const client = new SnowTransfer("TOKEN")
+     * const welcomeScreen = await client.guild.editGuildWelcomeScreen("guildId", { enabled: false })
+     */
+    editGuildWelcomeScreen(guildId: string, data: RESTPatchAPIGuildWelcomeScreenJSONBody, reason?: string): Promise<RESTPatchAPIGuildWelcomeScreenResult>;
+    /**
+     * Updates the current user's voice state in a stage channel
+     * @since 0.18.0
+     * @param guildId Id of the guild
+     * @param data Data of the voice state
+     * @returns Resolves the Promise on successful execution
+     *
+     * | Permissions needed | Condition                           |
+     * |--------------------|-------------------------------------|
+     * | MUTE_MEMBERS       | when trying to un-suppress yourself |
+     * | REQUEST_TO_SPEAK   | when trying to request to speak     |
+     *
+     * @example
+     * // Unsuppresses the CurrentUser in the stage channel they're in
+     * const client = new SnowTransfer("TOKEN")
+     * client.guild.editCurrentUserVoiceState("guildId", { channel_id: "channel id", suppress: false })
+     */
+    editCurrentUserVoiceState(guildId: string, data: RESTPatchAPIGuildVoiceStateCurrentMemberJSONBody): Promise<RESTPatchAPIGuildVoiceStateCurrentMemberResult>;
+    /**
+     * Updates a user's voice state in a stage channel
+     * @since 0.18.0
+     * @param guildId Id of the guild
+     * @param userId Id of the user
+     * @param data Data of the voice state
+     * @returns Resolves the Promise on successful execution
+     *
+     * | Permissions needed | Condition                           |
+     * |--------------------|-------------------------------------|
+     * | MUTE_MEMBERS       | when trying to suppress/un-suppress |
+     *
+     * @example
+     * // Suppresses the user in the stage channel they're in
+     * const client = new SnowTransfer("TOKEN")
+     * client.guild.editUserVoiceState("guildId", "userId", { channel_id: "channel id", suppress: true })
+     */
+    editUserVoiceState(guildId: string, userId: string, data: RESTPatchAPIGuildVoiceStateUserJSONBody): Promise<RESTPatchAPIGuildVoiceStateUserResult>;
+    /**
+     * Searches a guild for messages that match a query
+     * @since 0.17.6
+     * @param guildId Id of the guild
+     * @param options Options for the search
+     * @returns A [search result](https://docs.discord.com/developers/resources/message#search-guild-messages-response-body) containing the matched messages, or an index-not-ready response if the guild hasn't finished indexing yet
+     *
+     * | Permissions needed   | Condition |
+     * |----------------------|-----------|
+     * | READ_MESSAGE_HISTORY | Always    |
+     *
+     * @example
+     * // Finds messages that have the word "poggers" in their content
+     * const client = new SnowTransfer("TOKEN")
+     * const messages = await client.guild.searchGuildMessages("guildId", { content: "poggers" })
+     */
+    searchGuildMessages(guildId: string, options?: RESTGetAPIGuildMessagesSearchQuery): Promise<RESTGetAPIGuildMessagesSearchResult>;
+}
+export = GuildMethods;