oceanic.js 1.3.2 → 1.3.3-dev.092cc6f

package/dist/lib/routes/Channels.d.ts

@@ -13,6 +13,8 @@ import type PrivateChannel from "../structures/PrivateChannel";
 import type GroupChannel from "../structures/GroupChannel";
 import type User from "../structures/User";
 import type { Uncached } from "../types/shared";
+import type { CreateStageInstanceOptions, EditStageInstanceOptions } from "../types/guilds";
+import StageInstance from "../structures/StageInstance";
 /** Various methods for interacting with channels. */
 export default class Channels {
     #private;
@@ -25,10 +27,10 @@ export default class Channels {
     addGroupRecipient(groupID: string, options: AddGroupRecipientOptions): Promise<void>;
     /**
      * Add a member to a thread.
-     * @param id The ID of the thread to add them to.
+     * @param channelID The ID of the thread to add them to.
      * @param userID The ID of the user to add to the thread.
      */
-    addThreadMember(id: string, userID: string): Promise<void>;
+    addThreadMember(channelID: string, userID: string): Promise<void>;
     /**
      * Create a direct message. This will not create a new channel if you have already started a dm with the user.
      * @param recipient The ID of the recipient of the direct message.
@@ -41,35 +43,41 @@ export default class Channels {
     createGroupDM(options: CreateGroupChannelOptions): Promise<GroupChannel>;
     /**
      * Create an invite for a channel.
-     * @param id The ID of the channel to create an invite for.
+     * @param channelID The ID of the channel to create an invite for.
      * @param options The options for creating the invite.
      */
-    createInvite<T extends InviteInfoTypes, CH extends InviteChannel | PartialInviteChannel | Uncached = InviteChannel | PartialInviteChannel | Uncached>(id: string, options: CreateInviteOptions): Promise<Invite<T, CH>>;
+    createInvite<T extends InviteInfoTypes, CH extends InviteChannel | PartialInviteChannel | Uncached = InviteChannel | PartialInviteChannel | Uncached>(channelID: string, options: CreateInviteOptions): Promise<Invite<T, CH>>;
     /**
      * Create a message in a channel.
-     * @param id The ID of the channel to create the message in.
+     * @param channelID The ID of the channel to create the message in.
      * @param options The options for creating the message.
      */
-    createMessage<T extends AnyTextChannelWithoutGroup | Uncached = AnyTextChannelWithoutGroup | Uncached>(id: string, options: CreateMessageOptions): Promise<Message<T>>;
+    createMessage<T extends AnyTextChannelWithoutGroup | Uncached = AnyTextChannelWithoutGroup | Uncached>(channelID: string, options: CreateMessageOptions): Promise<Message<T>>;
     /**
      * Add a reaction to a message.
-     * @param id The ID of the channel the message is in.
+     * @param channelID The ID of the channel the message is in.
      * @param messageID The ID of the message to add a reaction to.
      * @param emoji The reaction to add to the message. `name:id` for custom emojis, and the unicode codepoint for default emojis.
      */
-    createReaction(id: string, messageID: string, emoji: string): Promise<void>;
+    createReaction(channelID: string, messageID: string, emoji: string): Promise<void>;
+    /**
+     * Create a stage instance.
+     * @param channelID The ID of the channel to create the stage instance on.
+     * @param options The options for creating the stage instance.
+     */
+    createStageInstance(channelID: string, options: CreateStageInstanceOptions): Promise<StageInstance>;
     /**
      * Crosspost a message in an announcement channel.
-     * @param id The ID of the channel to crosspost the message in.
+     * @param channelID The ID of the channel to crosspost the message in.
      * @param messageID The ID of the message to crosspost.
      */
-    crosspostMessage<T extends AnnouncementChannel | Uncached = AnnouncementChannel | Uncached>(id: string, messageID: string): Promise<Message<T>>;
+    crosspostMessage<T extends AnnouncementChannel | Uncached = AnnouncementChannel | Uncached>(channelID: string, messageID: string): Promise<Message<T>>;
     /**
      * Delete or close a channel.
-     * @param id The ID of the channel to delete or close.
+     * @param channelID The ID of the channel to delete or close.
      * @param reason The reason to be displayed in the audit log.
      */
-    delete(id: string, reason?: string): Promise<void>;
+    delete(channelID: string, reason?: string): Promise<void>;
     /**
      * Delete an invite.
      * @param code The code of the invite to delete.
@@ -78,71 +86,83 @@ export default class Channels {
     deleteInvite<T extends InviteChannel | PartialInviteChannel | Uncached = InviteChannel | PartialInviteChannel | Uncached>(code: string, reason?: string): Promise<Invite<"withMetadata", T>>;
     /**
      * Delete a message.
-     * @param id The ID of the channel to delete the message in.
+     * @param channelID The ID of the channel to delete the message in.
      * @param messageID The ID of the message to delete.
      * @param reason The reason for deleting the message.
      */
-    deleteMessage(id: string, messageID: string, reason?: string): Promise<void>;
+    deleteMessage(channelID: string, messageID: string, reason?: string): Promise<void>;
     /**
      * Bulk delete messages.
-     * @param id The ID of the channel to delete the messages in.
+     * @param channelID The ID of the channel to delete the messages in.
      * @param messageIDs The IDs of the messages to delete. Any duplicates or messages older than two weeks will cause an error.
      * @param reason The reason for deleting the messages.
      */
-    deleteMessages(id: string, messageIDs: Array<string>, reason?: string): Promise<number>;
+    deleteMessages(channelID: string, messageIDs: Array<string>, reason?: string): Promise<number>;
     /**
      * Delete a permission overwrite.
-     * @param id The ID of the channel to delete the permission overwrite in.
+     * @param channelID The ID of the channel to delete the permission overwrite in.
      * @param overwriteID The ID of the permission overwrite to delete.
      * @param reason The reason for deleting the permission overwrite.
      */
-    deletePermission(id: string, overwriteID: string, reason?: string): Promise<void>;
+    deletePermission(channelID: string, overwriteID: string, reason?: string): Promise<void>;
     /**
      * Remove a reaction from a message.
-     * @param id The ID of the channel the message is in.
+     * @param channelID The ID of the channel the message is in.
      * @param messageID The ID of the message to remove a reaction from.
      * @param emoji The reaction to remove from the message. `name:id` for custom emojis, and the unicode codepoint for default emojis.
      * @param user The user to remove the reaction from, `@me` for the current user (default).
      */
-    deleteReaction(id: string, messageID: string, emoji: string, user?: string): Promise<void>;
+    deleteReaction(channelID: string, messageID: string, emoji: string, user?: string): Promise<void>;
     /**
      * Remove all, or a specific emoji's reactions from a message.
-     * @param id The ID of the channel the message is in.
+     * @param channelID The ID of the channel the message is in.
      * @param messageID The ID of the message to remove reactions from.
      * @param emoji The reaction to remove from the message. `name:id` for custom emojis, and the unicode codepoint for default emojis. Omit to remove all reactions.
      */
-    deleteReactions(id: string, messageID: string, emoji?: string): Promise<void>;
+    deleteReactions(channelID: string, messageID: string, emoji?: string): Promise<void>;
+    /**
+     * Delete a stage instance.
+     * @param channelID The ID of the channel to delete the stage instance on.
+     * @param reason The reason for deleting the stage instance.
+     */
+    deleteStageInstance(channelID: string, reason?: string): Promise<void>;
     /**
      * Edit a channel.
-     * @param id The ID of the channel to edit.
+     * @param channelID The ID of the channel to edit.
      * @param options The options for editing the channel.
      */
-    edit<T extends AnyEditableChannel = AnyEditableChannel>(id: string, options: EditChannelOptions): Promise<T>;
+    edit<T extends AnyEditableChannel = AnyEditableChannel>(channelID: string, options: EditChannelOptions): Promise<T>;
     /**
      * Edit a message.
-     * @param id The ID of the channel the message is in.
+     * @param channelID The ID of the channel the message is in.
      * @param messageID The ID of the message to edit.
      * @param options The options for editing the message.
      */
-    editMessage<T extends AnyTextChannelWithoutGroup | Uncached = AnyTextChannelWithoutGroup | Uncached>(id: string, messageID: string, options: EditMessageOptions): Promise<Message<T>>;
+    editMessage<T extends AnyTextChannelWithoutGroup | Uncached = AnyTextChannelWithoutGroup | Uncached>(channelID: string, messageID: string, options: EditMessageOptions): Promise<Message<T>>;
     /**
      * Edit a permission overwrite.
-     * @param id The ID of the channel to edit the permission overwrite for.
+     * @param channelID The ID of the channel to edit the permission overwrite for.
      * @param overwriteID The ID of the permission overwrite to edit.
      * @param options The options for editing the permission overwrite.
      */
-    editPermission(id: string, overwriteID: string, options: EditPermissionOptions): Promise<void>;
+    editPermission(channelID: string, overwriteID: string, options: EditPermissionOptions): Promise<void>;
+    /**
+     * Edit a stage instance.
+     * @param channelID The ID of the channel to edit the stage instance on.
+     * @param options The options for editing the stage instance.
+     */
+    editStageInstance(channelID: string, options: EditStageInstanceOptions): Promise<StageInstance>;
     /**
      * Follow an announcement channel.
-     * @param id The ID of the channel to follow the announcement channel to.
+     * @param channelID The ID of the channel to follow the announcement channel to.
      * @param webhookChannelID The ID of the channel to follow the announcement channel to.
      */
-    followAnnouncement(id: string, webhookChannelID: string): Promise<FollowedChannel>;
+    followAnnouncement(channelID: string, webhookChannelID: string): Promise<FollowedChannel>;
     /**
      * Get a channel.
-     * @param id The ID of the channel to get.
+     * @param channelID The ID of the channel to get.
      */
-    get<T extends AnyChannel = AnyChannel>(id: string): Promise<T>;
+    get<T extends AnyChannel = AnyChannel>(channelID: string): Promise<T>;
     /**
      * Get an invite.
      * @param code The code of the invite to get.
@@ -154,88 +174,93 @@ export default class Channels {
     getInvite<T extends InviteChannel | PartialInviteChannel | Uncached = InviteChannel | PartialInviteChannel | Uncached>(code: string, options: GetInviteWithExpirationOptions): Promise<Invite<"withMetadata" | "withExpiration", T>>;
     /**
      * Get the invites of a channel.
-     * @param id The ID of the channel to get the invites of.
+     * @param channelID The ID of the channel to get the invites of.
      */
-    getInvites<T extends InviteChannel | PartialInviteChannel | Uncached = InviteChannel | PartialInviteChannel | Uncached>(id: string): Promise<Array<Invite<"withMetadata", T>>>;
+    getInvites<T extends InviteChannel | PartialInviteChannel | Uncached = InviteChannel | PartialInviteChannel | Uncached>(channelID: string): Promise<Array<Invite<"withMetadata", T>>>;
     /**
      * Get the private archived threads the current user has joined in a channel.
-     * @param id The ID of the channel to get the archived threads from.
+     * @param channelID The ID of the channel to get the archived threads from.
      * @param options The options for getting the archived threads.
      */
-    getJoinedPrivateArchivedThreads(id: string, options?: GetArchivedThreadsOptions): Promise<ArchivedThreads<PrivateThreadChannel>>;
+    getJoinedPrivateArchivedThreads(channelID: string, options?: GetArchivedThreadsOptions): Promise<ArchivedThreads<PrivateThreadChannel>>;
     /**
      * Get a message in a channel.
-     * @param id The ID of the channel the message is in
+     * @param channelID The ID of the channel the message is in
      * @param messageID The ID of the message to get.
      */
-    getMessage<T extends AnyTextChannelWithoutGroup | Uncached = AnyTextChannelWithoutGroup | Uncached>(id: string, messageID: string): Promise<Message<T>>;
+    getMessage<T extends AnyTextChannelWithoutGroup | Uncached = AnyTextChannelWithoutGroup | Uncached>(channelID: string, messageID: string): Promise<Message<T>>;
     /**
      * Get messages in a channel.
-     * @param id The ID of the channel to get messages from.
+     * @param channelID The ID of the channel to get messages from.
      * @param options The options for getting messages. `before`, `after`, and `around `All are mutually exclusive.
      */
-    getMessages<T extends AnyTextChannelWithoutGroup | Uncached = AnyTextChannelWithoutGroup | Uncached>(id: string, options?: GetChannelMessagesOptions): Promise<Array<Message<T>>>;
+    getMessages<T extends AnyTextChannelWithoutGroup | Uncached = AnyTextChannelWithoutGroup | Uncached>(channelID: string, options?: GetChannelMessagesOptions): Promise<Array<Message<T>>>;
     /**
      * Get the pinned messages in a channel.
-     * @param id The ID of the channel to get the pinned messages from.
+     * @param channelID The ID of the channel to get the pinned messages from.
      */
-    getPinnedMessages<T extends AnyTextChannelWithoutGroup | Uncached = AnyTextChannelWithoutGroup | Uncached>(id: string): Promise<Array<Message<T>>>;
+    getPinnedMessages<T extends AnyTextChannelWithoutGroup | Uncached = AnyTextChannelWithoutGroup | Uncached>(channelID: string): Promise<Array<Message<T>>>;
     /**
      * Get the private archived threads in a channel.
-     * @param id The ID of the channel to get the archived threads from.
+     * @param channelID The ID of the channel to get the archived threads from.
      * @param options The options for getting the archived threads.
      */
-    getPrivateArchivedThreads(id: string, options?: GetArchivedThreadsOptions): Promise<ArchivedThreads<PrivateThreadChannel>>;
+    getPrivateArchivedThreads(channelID: string, options?: GetArchivedThreadsOptions): Promise<ArchivedThreads<PrivateThreadChannel>>;
     /**
      * Get the public archived threads in a channel.
-     * @param id The ID of the channel to get the archived threads from.
+     * @param channelID The ID of the channel to get the archived threads from.
      * @param options The options for getting the archived threads.
      */
-    getPublicArchivedThreads<T extends AnnouncementThreadChannel | PublicThreadChannel = AnnouncementThreadChannel | PublicThreadChannel>(id: string, options?: GetArchivedThreadsOptions): Promise<ArchivedThreads<T>>;
+    getPublicArchivedThreads<T extends AnnouncementThreadChannel | PublicThreadChannel = AnnouncementThreadChannel | PublicThreadChannel>(channelID: string, options?: GetArchivedThreadsOptions): Promise<ArchivedThreads<T>>;
     /**
      * Get the users who reacted with a specific emoji on a message.
-     * @param id The ID of the channel the message is in.
+     * @param channelID The ID of the channel the message is in.
      * @param messageID The ID of the message to get reactions from.
      * @param emoji The reaction to remove from the message. `name:id` for custom emojis, and the unicode codepoint for default emojis.
      * @param options The options for getting the reactions.
      */
-    getReactions(id: string, messageID: string, emoji: string, options?: GetReactionsOptions): Promise<Array<User>>;
+    getReactions(channelID: string, messageID: string, emoji: string, options?: GetReactionsOptions): Promise<Array<User>>;
+    /**
+     * Get the stage instance associated with a channel.
+     * @param channelID The ID of the channel to get the stage instance on.
+     */
+    getStageInstance(channelID: string): Promise<StageInstance>;
     /**
      * Get a thread member.
-     * @param id The ID of the thread.
+     * @param channelID The ID of the thread.
      * @param userID The ID of the user to get the thread member of.
      */
-    getThreadMember(id: string, userID: string): Promise<ThreadMember>;
+    getThreadMember(channelID: string, userID: string): Promise<ThreadMember>;
     /**
      * Get the members of a thread.
-     * @param id The ID of the thread.
+     * @param channelID The ID of the thread.
      */
-    getThreadMembers(id: string): Promise<Array<ThreadMember>>;
+    getThreadMembers(channelID: string): Promise<Array<ThreadMember>>;
     /** @deprecated Get the list of usable voice regions. Moved to `misc`. */
     getVoiceRegions(): Promise<Array<VoiceRegion>>;
     /**
      * Join a thread.
-     * @param id The ID of the thread to join.
+     * @param channelID The ID of the thread to join.
      */
-    joinThread(id: string): Promise<void>;
+    joinThread(channelID: string): Promise<void>;
     /**
      * Leave a thread.
-     * @param id The ID of the thread to leave.
+     * @param channelID The ID of the thread to leave.
      */
-    leaveThread(id: string): Promise<void>;
+    leaveThread(channelID: string): Promise<void>;
     /**
      * Pin a message in a channel.
-     * @param id The ID of the channel to pin the message in.
+     * @param channelID The ID of the channel to pin the message in.
      * @param messageID The ID of the message to pin.
      * @param reason The reason for pinning the message.
      */
-    pinMessage(id: string, messageID: string, reason?: string): Promise<void>;
+    pinMessage(channelID: string, messageID: string, reason?: string): Promise<void>;
     /**
      * Purge an amount of messages from a channel.
-     * @param id The ID of the channel to purge.
+     * @param channelID The ID of the channel to purge.
      * @param options The options to purge. `before`, `after`, and `around `All are mutually exclusive.
      */
-    purgeMessages<T extends AnyGuildTextChannel | Uncached = AnyGuildTextChannel | Uncached>(id: string, options: PurgeOptions<T>): Promise<number>;
+    purgeMessages<T extends AnyGuildTextChannel | Uncached = AnyGuildTextChannel | Uncached>(channelID: string, options: PurgeOptions<T>): Promise<number>;
     /**
      * Remove a user from the group channel.
      * @param groupID The ID of the group to remove the user from.
@@ -244,39 +269,39 @@ export default class Channels {
     removeGroupRecipient(groupID: string, userID: string): Promise<void>;
     /**
      * Remove a member from a thread.
-     * @param id The ID of the thread to remove them from.
+     * @param channelID The ID of the thread to remove them from.
      * @param userID The ID of the user to remove from the thread.
      */
-    removeThreadMember(id: string, userID: string): Promise<void>;
+    removeThreadMember(channelID: string, userID: string): Promise<void>;
     /**
      * Show a typing indicator in a channel. How long users see this varies from client to client.
-     * @param id The ID of the channel to show the typing indicator in.
+     * @param channelID The ID of the channel to show the typing indicator in.
      */
-    sendTyping(id: string): Promise<void>;
+    sendTyping(channelID: string): Promise<void>;
     /**
      * Create a thread from an existing message.
-     * @param id The ID of the channel to create the thread in.
+     * @param channelID The ID of the channel to create the thread in.
      * @param messageID The ID of the message to create the thread from.
      * @param options The options for starting the thread.
      */
-    startThreadFromMessage<T extends AnnouncementThreadChannel | PublicThreadChannel = AnnouncementThreadChannel | PublicThreadChannel>(id: string, messageID: string, options: StartThreadFromMessageOptions): Promise<T>;
+    startThreadFromMessage<T extends AnnouncementThreadChannel | PublicThreadChannel = AnnouncementThreadChannel | PublicThreadChannel>(channelID: string, messageID: string, options: StartThreadFromMessageOptions): Promise<T>;
     /**
      * Create a thread in a forum channel.
-     * @param id The ID of the channel to start the thread in.
+     * @param channelID The ID of the channel to start the thread in.
      * @param options The options for starting the thread.
      */
-    startThreadInForum(id: string, options: StartThreadInForumOptions): Promise<PublicThreadChannel>;
+    startThreadInForum(channelID: string, options: StartThreadInForumOptions): Promise<PublicThreadChannel>;
     /**
      * Create a thread without an existing message.
-     * @param id The ID of the channel to start the thread in.
+     * @param channelID The ID of the channel to start the thread in.
      * @param options The options for starting the thread.
      */
-    startThreadWithoutMessage<T extends AnnouncementThreadChannel | PublicThreadChannel | PrivateThreadChannel = AnnouncementThreadChannel | PublicThreadChannel | PrivateThreadChannel>(id: string, options: StartThreadWithoutMessageOptions): Promise<T>;
+    startThreadWithoutMessage<T extends AnnouncementThreadChannel | PublicThreadChannel | PrivateThreadChannel = AnnouncementThreadChannel | PublicThreadChannel | PrivateThreadChannel>(channelID: string, options: StartThreadWithoutMessageOptions): Promise<T>;
     /**
      * Unpin a message in a channel.
-     * @param id The ID of the channel to unpin the message in.
+     * @param channelID The ID of the channel to unpin the message in.
      * @param messageID The ID of the message to unpin.
      * @param reason The reason for unpinning the message.
      */
-    unpinMessage(id: string, messageID: string, reason?: string): Promise<void>;
+    unpinMessage(channelID: string, messageID: string, reason?: string): Promise<void>;
 }