e621 2.2.6 → 3.0.1

package/dist/lib/modules/ForumPosts.d.ts

@@ -0,0 +1,110 @@
+import Base from "./Base.js";
+import ForumPostVotes from "./forum_posts/Votes.js";
+import type { CreateForumPostData, EditForumPostData, MarkForumPostData, MarkForumPostResponses, SearchForumPostsData } from "../generated/types.js";
+import { type ExtractValue, type TransformDataBodyToOptions, type TransformDataQueryToOptions, GetResponse } from "../util.js";
+import ForumPost from "../models/ForumPost.js";
+/** @category Modules/Types */
+export interface CreateForumPostOptions extends TransformDataBodyToOptions<CreateForumPostData> {
+}
+/** @category Modules/Types */
+export interface EditForumPostOptions extends TransformDataBodyToOptions<EditForumPostData> {
+}
+/** @category Modules/Types */
+export interface SearchForumPostsOptions extends TransformDataQueryToOptions<SearchForumPostsData> {
+}
+/** @category Modules/Types */
+export interface MarkForumPostResponse extends GetResponse<MarkForumPostResponses, 200> {
+}
+/** @category Modules */
+export default class ForumPosts extends Base {
+    votes: ForumPostVotes;
+    /**
+     * Create Forum Post
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-createForumPost createForumPost}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-createForumPost Documentation} for more details.
+     */
+    create(options: CreateForumPostOptions): Promise<ForumPost>;
+    /**
+     * Delete Forum Post
+     *
+     * You must be Admin+.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-deleteForumPost deleteForumPost}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-deleteForumPost Documentation} for more details.
+     */
+    delete(id: number): Promise<null>;
+    /**
+     * Edit Forum Post
+     *
+     * You must be the creator of the forum post, or Admin+ to edit. Marked forum posts cannot be edited.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-editForumPost editForumPost}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-editForumPost Documentation} for more details.
+     */
+    edit(id: number, options: EditForumPostOptions): Promise<null>;
+    /**
+     * Get Forum Post
+     *
+     * If the forum post is hidden, you must be the creator or Moderator+ to see it.
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-getForumPost getForumPost}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-getForumPost Documentation} for more details.
+     */
+    get(id: number): Promise<ForumPost | null>;
+    /**
+     * Hide Forum Post
+     *
+     * You must be the creator or Moderator+.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-hideForumPost hideForumPost}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-hideForumPost Documentation} for more details.
+     */
+    hide(id: number): Promise<ForumPost>;
+    /**
+     * Mark Forum Post
+     *
+     * You must be Moderator+.
+
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-markForumPost markForumPost}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-markForumPost Documentation} for more details.
+     */
+    mark(id: number, type: ExtractValue<"record_type", MarkForumPostData>): Promise<MarkForumPostResponse>;
+    /**
+     * Search Forum Posts
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-searchForumPosts searchForumPosts}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-searchForumPosts Documentation} for more details.
+     */
+    search(options?: SearchForumPostsOptions): Promise<Array<ForumPost>>;
+    /**
+     * Unhide Forum Post
+     *
+     * You must be Moderator+.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-unhideForumPost unhideForumPost}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-unhideForumPost Documentation} for more details.
+     */
+    unhide(id: number): Promise<ForumPost>;
+}

package/dist/lib/modules/ForumPosts.js

@@ -0,0 +1,190 @@
+import { __decorate, __metadata } from "tslib";
+import Base from "./Base.js";
+import ForumPostVotes from "./forum_posts/Votes.js";
+import { createForumPost, deleteForumPost, editForumPost, getForumPost, hideForumPost, markForumPost, searchForumPosts, unhideForumPost } from "../generated/sdk.js";
+import { OperationID, prefixKeys } from "../util.js";
+import ForumPost from "../models/ForumPost.js";
+/** @category Modules */
+export default class ForumPosts extends Base {
+    votes = new ForumPostVotes(this.e621, this.client);
+    /**
+     * Create Forum Post
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-createForumPost createForumPost}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-createForumPost Documentation} for more details.
+     */
+    async create(options) {
+        return createForumPost({
+            client: this.client,
+            body: prefixKeys(options, "forum_post")
+        }).then(res => this._handleResponse(res, 201, true, ForumPost));
+    }
+    /**
+     * Delete Forum Post
+     *
+     * You must be Admin+.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-deleteForumPost deleteForumPost}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-deleteForumPost Documentation} for more details.
+     */
+    async delete(id) {
+        return deleteForumPost({
+            client: this.client,
+            path: { id }
+        }).then(res => this._handleResponse(res, 204, true));
+    }
+    /**
+     * Edit Forum Post
+     *
+     * You must be the creator of the forum post, or Admin+ to edit. Marked forum posts cannot be edited.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-editForumPost editForumPost}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-editForumPost Documentation} for more details.
+     */
+    async edit(id, options) {
+        return editForumPost({
+            client: this.client,
+            path: { id },
+            body: prefixKeys(options, "forum_post")
+        }).then(res => this._handleResponse(res, 204, true));
+    }
+    /**
+     * Get Forum Post
+     *
+     * If the forum post is hidden, you must be the creator or Moderator+ to see it.
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-getForumPost getForumPost}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-getForumPost Documentation} for more details.
+     */
+    async get(id) {
+        return getForumPost({
+            client: this.client,
+            path: { id }
+        }).then(res => this._handleResponse(res, 200, false, ForumPost));
+    }
+    /**
+     * Hide Forum Post
+     *
+     * You must be the creator or Moderator+.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-hideForumPost hideForumPost}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-hideForumPost Documentation} for more details.
+     */
+    async hide(id) {
+        return hideForumPost({
+            client: this.client,
+            path: { id }
+        }).then(res => this._handleResponse(res, 201, true, ForumPost));
+    }
+    /**
+     * Mark Forum Post
+     *
+     * You must be Moderator+.
+
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-markForumPost markForumPost}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-markForumPost Documentation} for more details.
+     */
+    async mark(id, type) {
+        return markForumPost({
+            client: this.client,
+            path: { id },
+            body: { record_type: type }
+        }).then(res => this._handleResponse(res, 200, true));
+    }
+    /**
+     * Search Forum Posts
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-searchForumPosts searchForumPosts}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-searchForumPosts Documentation} for more details.
+     */
+    async search(options) {
+        return searchForumPosts({
+            client: this.client,
+            query: prefixKeys(options, "search", ["limit", "page"])
+        }).then(res => this._handleResponse(res, 200, true, ForumPost));
+    }
+    /**
+     * Unhide Forum Post
+     *
+     * You must be Moderator+.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Posts-unhideForumPost unhideForumPost}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Posts-unhideForumPost Documentation} for more details.
+     */
+    async unhide(id) {
+        return unhideForumPost({
+            client: this.client,
+            path: { id }
+        }).then(res => this._handleResponse(res, 201, true, ForumPost));
+    }
+}
+__decorate([
+    OperationID("createForumPost"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ForumPosts.prototype, "create", null);
+__decorate([
+    OperationID("deleteForumPost"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", Promise)
+], ForumPosts.prototype, "delete", null);
+__decorate([
+    OperationID("editForumPost"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number, Object]),
+    __metadata("design:returntype", Promise)
+], ForumPosts.prototype, "edit", null);
+__decorate([
+    OperationID("getForumPost"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", Promise)
+], ForumPosts.prototype, "get", null);
+__decorate([
+    OperationID("hideForumPost"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", Promise)
+], ForumPosts.prototype, "hide", null);
+__decorate([
+    OperationID("markForumPost"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number, Object]),
+    __metadata("design:returntype", Promise)
+], ForumPosts.prototype, "mark", null);
+__decorate([
+    OperationID("searchForumPosts"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ForumPosts.prototype, "search", null);
+__decorate([
+    OperationID("unhideForumPost"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", Promise)
+], ForumPosts.prototype, "unhide", null);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRm9ydW1Qb3N0cy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL2xpYi9tb2R1bGVzL0ZvcnVtUG9zdHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLE9BQU8sSUFBSSxNQUFNLFdBQVcsQ0FBQztBQUM3QixPQUFPLGNBQWMsTUFBTSx3QkFBd0IsQ0FBQztBQUNwRCxPQUFPLEVBQ0gsZUFBZSxFQUNmLGVBQWUsRUFDZixhQUFhLEVBQ2IsWUFBWSxFQUNaLGFBQWEsRUFDYixhQUFhLEVBQ2IsZ0JBQWdCLEVBQ2hCLGVBQWUsRUFDbEIsTUFBTSxxQkFBcUIsQ0FBQztBQVE3QixPQUFPLEVBQ0gsV0FBVyxFQUVYLFVBQVUsRUFJYixNQUFNLFlBQVksQ0FBQztBQUNwQixPQUFPLFNBQVMsTUFBTSx3QkFBd0IsQ0FBQztBQVcvQyx3QkFBd0I7QUFDeEIsTUFBTSxDQUFDLE9BQU8sT0FBTyxVQUFXLFNBQVEsSUFBSTtJQUN4QyxLQUFLLEdBQUcsSUFBSSxjQUFjLENBQUMsSUFBSSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDbkQ7Ozs7Ozs7O09BUUE7SUFFTSxBQUFOLEtBQUssQ0FBQyxNQUFNLENBQUMsT0FBK0I7UUFDeEMsT0FBTyxlQUFlLENBQUM7WUFDbkIsTUFBTSxFQUFFLElBQUksQ0FBQyxNQUFNO1lBQ25CLElBQUksRUFBSSxVQUFVLENBQUMsT0FBTyxFQUFFLFlBQVksQ0FBQztTQUM1QyxDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLElBQUksRUFBRSxTQUFTLENBQUMsQ0FBQyxDQUFDO0lBQ3BFLENBQUM7SUFFRDs7Ozs7Ozs7OztPQVVBO0lBRU0sQUFBTixLQUFLLENBQUMsTUFBTSxDQUFDLEVBQVU7UUFDbkIsT0FBTyxlQUFlLENBQUM7WUFDbkIsTUFBTSxFQUFFLElBQUksQ0FBQyxNQUFNO1lBQ25CLElBQUksRUFBSSxFQUFFLEVBQUUsRUFBRTtTQUNqQixDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLElBQUksQ0FBQyxDQUFDLENBQUM7SUFDekQsQ0FBQztJQUVEOzs7Ozs7Ozs7O09BVUE7SUFFTSxBQUFOLEtBQUssQ0FBQyxJQUFJLENBQUMsRUFBVSxFQUFFLE9BQTZCO1FBQ2hELE9BQU8sYUFBYSxDQUFDO1lBQ2pCLE1BQU0sRUFBRSxJQUFJLENBQUMsTUFBTTtZQUNuQixJQUFJLEVBQUksRUFBRSxFQUFFLEVBQUU7WUFDZCxJQUFJLEVBQUksVUFBVSxDQUFDLE9BQU8sRUFBRSxZQUFZLENBQUM7U0FDNUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsR0FBRyxFQUFFLEdBQUcsRUFBRSxJQUFJLENBQUMsQ0FBQyxDQUFDO0lBQ3pELENBQUM7SUFFRDs7Ozs7Ozs7T0FRQTtJQUVNLEFBQU4sS0FBSyxDQUFDLEdBQUcsQ0FBQyxFQUFVO1FBQ2hCLE9BQU8sWUFBWSxDQUFDO1lBQ2hCLE1BQU0sRUFBRSxJQUFJLENBQUMsTUFBTTtZQUNuQixJQUFJLEVBQUksRUFBRSxFQUFFLEVBQUU7U0FDakIsQ0FBQyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsR0FBRyxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsU0FBUyxDQUFDLENBQUMsQ0FBQztJQUNyRSxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7T0FVQTtJQUVNLEFBQU4sS0FBSyxDQUFDLElBQUksQ0FBQyxFQUFVO1FBQ2pCLE9BQU8sYUFBYSxDQUFDO1lBQ2pCLE1BQU0sRUFBRSxJQUFJLENBQUMsTUFBTTtZQUNuQixJQUFJLEVBQUksRUFBRSxFQUFFLEVBQUU7U0FDakIsQ0FBQyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsR0FBRyxFQUFFLEdBQUcsRUFBRSxJQUFJLEVBQUUsU0FBUyxDQUFDLENBQUMsQ0FBQztJQUNwRSxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7O09BV0E7SUFFTSxBQUFOLEtBQUssQ0FBQyxJQUFJLENBQUMsRUFBVSxFQUFFLElBQW9EO1FBQ3ZFLE9BQU8sYUFBYSxDQUFDO1lBQ2pCLE1BQU0sRUFBRSxJQUFJLENBQUMsTUFBTTtZQUNuQixJQUFJLEVBQUksRUFBRSxFQUFFLEVBQUU7WUFDZCxJQUFJLEVBQUksRUFBRSxXQUFXLEVBQUUsSUFBSSxFQUFFO1NBQ2hDLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsSUFBSSxDQUFDLENBQUMsQ0FBQztJQUN6RCxDQUFDO0lBRUQ7Ozs7OztPQU1BO0lBRU0sQUFBTixLQUFLLENBQUMsTUFBTSxDQUFDLE9BQWlDO1FBQzFDLE9BQU8sZ0JBQWdCLENBQUM7WUFDcEIsTUFBTSxFQUFFLElBQUksQ0FBQyxNQUFNO1lBQ25CLEtBQUssRUFBRyxVQUFVLENBQUMsT0FBTyxFQUFFLFFBQVEsRUFBRSxDQUFDLE9BQU8sRUFBRSxNQUFNLENBQUMsQ0FBQztTQUMzRCxDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLElBQUksRUFBRSxTQUFTLENBQUMsQ0FBQyxDQUFDO0lBQ3BFLENBQUM7SUFFRDs7Ozs7Ozs7OztPQVVBO0lBRU0sQUFBTixLQUFLLENBQUMsTUFBTSxDQUFDLEVBQVU7UUFDbkIsT0FBTyxlQUFlLENBQUM7WUFDbkIsTUFBTSxFQUFFLElBQUksQ0FBQyxNQUFNO1lBQ25CLElBQUksRUFBSSxFQUFFLEVBQUUsRUFBRTtTQUNqQixDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLElBQUksRUFBRSxTQUFTLENBQUMsQ0FBQyxDQUFDO0lBQ3BFLENBQUM7Q0FDSjtBQXhJUztJQURSLFdBQVcsQ0FBQyxpQkFBaUIsQ0FBQzs7Ozt3Q0FNM0I7QUFjSztJQURSLFdBQVcsQ0FBQyxpQkFBaUIsQ0FBQzs7Ozt3Q0FNM0I7QUFjSztJQURSLFdBQVcsQ0FBQyxlQUFlLENBQUM7Ozs7c0NBT3pCO0FBWUs7SUFEUixXQUFXLENBQUMsY0FBYyxDQUFDOzs7O3FDQU14QjtBQWNLO0lBRFIsV0FBVyxDQUFDLGVBQWUsQ0FBQzs7OztzQ0FNekI7QUFlSztJQURSLFdBQVcsQ0FBQyxlQUFlLENBQUM7Ozs7c0NBT3pCO0FBVUs7SUFEUixXQUFXLENBQUMsa0JBQWtCLENBQUM7Ozs7d0NBTTVCO0FBY0s7SUFEUixXQUFXLENBQUMsaUJBQWlCLENBQUM7Ozs7d0NBTTNCIn0=

package/dist/lib/modules/ForumTopics.d.ts

@@ -0,0 +1,125 @@
+import Base from "./Base.js";
+import type { SearchForumTopicsData } from "../generated/types.js";
+import { type TransformDataQueryToOptions } from "../util.js";
+import ForumTopic from "../models/ForumTopic.js";
+/** @category Modules/Types */
+export interface ForumTopicOptions {
+    category_id: number;
+    is_locked?: boolean;
+    is_sticky?: boolean;
+    original_post_attributes?: {
+        body?: string;
+        id?: number;
+    };
+    title: string;
+}
+/** @category Modules/Types */
+export interface SearchForumTopicsOptions extends TransformDataQueryToOptions<SearchForumTopicsData> {
+}
+/** @category Modules */
+export default class ForumTopics extends Base {
+    /**
+     * Create Forum Topic
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-createForumTopic createForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-createForumTopic Documentation} for more details.
+     */
+    create(options: ForumTopicOptions): Promise<ForumTopic>;
+    /**
+     * Delete Forum Topic
+     *
+     * You must be Admin+.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-deleteForumTopic deleteForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-deleteForumTopic Documentation} for more details.
+     */
+    delete(id: number): Promise<null>;
+    /**
+     * Edit Forum Topic
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-editForumTopic editForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-editForumTopic Documentation} for more details.
+     */
+    edit(id: number, options: ForumTopicOptions): Promise<null>;
+    /**
+     * Get Forum Forum Topic
+     *
+     * If the forum topic is hidden, you must be the creator or Moderator+ to see it.
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-getForumTopic getForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-getForumTopic Documentation} for more details.
+     */
+    get(id: number): Promise<ForumTopic | null>;
+    /**
+     * Hide Forum Topic
+     *
+     * You must be the creator or Moderator+.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-hideForumTopic hideForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-hideForumTopic Documentation} for more details.
+     */
+    hide(id: number): Promise<ForumTopic>;
+    /**
+     * Mark All Forum Topics As Read
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-markAllForumTopicsAsRead markAllForumTopicsAsRead}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-markAllForumTopicsAsRead Documentation} for more details.
+     */
+    markAllRead(): Promise<null>;
+    /**
+     * Search Forum Topics
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-searchForumTopics searchForumTopics}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-searchForumTopics Documentation} for more details.
+     */
+    search(options?: SearchForumTopicsOptions): Promise<Array<ForumTopic>>;
+    /**
+     * Subscribe To Forum Topic
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-subscribeForumTopic subscribeForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-subscribeForumTopic Documentation} for more details.
+     */
+    subscribe(id: number): Promise<ForumTopic>;
+    /**
+     * Unhide Forum Topic
+     *
+     * You must be Moderator+.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-unhideForumTopic unhideForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-unhideForumTopic Documentation} for more details.
+     */
+    unhide(id: number): Promise<ForumTopic>;
+    /**
+     * Unsubscribe From Forum Topic
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-unsubscribeForumTopic unsubscribeForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-unsubscribeForumTopic Documentation} for more details.
+     */
+    unsubscribe(id: number): Promise<ForumTopic>;
+}

package/dist/lib/modules/ForumTopics.js

@@ -0,0 +1,237 @@
+import { __decorate, __metadata } from "tslib";
+import Base from "./Base.js";
+import { createForumTopic, deleteForumTopic, editForumTopic, getForumTopic, hideForumTopic, markAllForumTopicsAsRead, searchForumTopics, subscribeForumTopic, unhideForumTopic, unsubscribeForumTopic } from "../generated/sdk.js";
+import { OperationID, prefixKeys } from "../util.js";
+import ForumTopic from "../models/ForumTopic.js";
+/** @category Modules */
+export default class ForumTopics extends Base {
+    /**
+     * Create Forum Topic
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-createForumTopic createForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-createForumTopic Documentation} for more details.
+     */
+    async create(options) {
+        return createForumTopic({
+            client: this.client,
+            body: {
+                "forum_topic[category_id]": options.category_id,
+                "forum_topic[is_locked]": options.is_locked,
+                "forum_topic[is_sticky]": options.is_sticky,
+                "forum_topic[original_post_attributes][body]": options.original_post_attributes?.body,
+                "forum_topic[original_post_attributes][id]": options.original_post_attributes?.id,
+                "forum_topic[title]": options.title
+            }
+        }).then(res => this._handleResponse(res, 201, true, ForumTopic));
+    }
+    /**
+     * Delete Forum Topic
+     *
+     * You must be Admin+.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-deleteForumTopic deleteForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-deleteForumTopic Documentation} for more details.
+     */
+    async delete(id) {
+        return deleteForumTopic({
+            client: this.client,
+            path: { id }
+        }).then(res => this._handleResponse(res, 204, true));
+    }
+    /**
+     * Edit Forum Topic
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-editForumTopic editForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-editForumTopic Documentation} for more details.
+     */
+    async edit(id, options) {
+        return editForumTopic({
+            client: this.client,
+            path: { id },
+            body: {
+                "forum_topic[category_id]": options.category_id,
+                "forum_topic[is_locked]": options.is_locked,
+                "forum_topic[is_sticky]": options.is_sticky,
+                "forum_topic[original_post_attributes][body]": options.original_post_attributes?.body,
+                "forum_topic[original_post_attributes][id]": options.original_post_attributes?.id,
+                "forum_topic[title]": options.title
+            }
+        }).then(res => this._handleResponse(res, 204, true));
+    }
+    /**
+     * Get Forum Forum Topic
+     *
+     * If the forum topic is hidden, you must be the creator or Moderator+ to see it.
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-getForumTopic getForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-getForumTopic Documentation} for more details.
+     */
+    async get(id) {
+        return getForumTopic({
+            client: this.client,
+            path: { id }
+        }).then(res => this._handleResponse(res, 200, false, ForumTopic));
+    }
+    /**
+     * Hide Forum Topic
+     *
+     * You must be the creator or Moderator+.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-hideForumTopic hideForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-hideForumTopic Documentation} for more details.
+     */
+    async hide(id) {
+        return hideForumTopic({
+            client: this.client,
+            path: { id }
+        }).then(res => this._handleResponse(res, 201, true, ForumTopic));
+    }
+    /**
+     * Mark All Forum Topics As Read
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-markAllForumTopicsAsRead markAllForumTopicsAsRead}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-markAllForumTopicsAsRead Documentation} for more details.
+     */
+    async markAllRead() {
+        return markAllForumTopicsAsRead({
+            client: this.client
+        }).then(res => this._handleResponse(res, 204, true));
+    }
+    /**
+     * Search Forum Topics
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-searchForumTopics searchForumTopics}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-searchForumTopics Documentation} for more details.
+     */
+    async search(options) {
+        return searchForumTopics({
+            client: this.client,
+            query: prefixKeys(options, "search", ["limit", "page"])
+        }).then(res => this._handleResponse(res, 200, true, ForumTopic));
+    }
+    /**
+     * Subscribe To Forum Topic
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-subscribeForumTopic subscribeForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-subscribeForumTopic Documentation} for more details.
+     */
+    async subscribe(id) {
+        return subscribeForumTopic({
+            client: this.client,
+            path: { id }
+        }).then(res => this._handleResponse(res, 201, true, ForumTopic));
+    }
+    /**
+     * Unhide Forum Topic
+     *
+     * You must be Moderator+.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-unhideForumTopic unhideForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-unhideForumTopic Documentation} for more details.
+     */
+    async unhide(id) {
+        return unhideForumTopic({
+            client: this.client,
+            path: { id }
+        }).then(res => this._handleResponse(res, 201, true, ForumTopic));
+    }
+    /**
+     * Unsubscribe From Forum Topic
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Forum_Topics-unsubscribeForumTopic unsubscribeForumTopic}
+     *
+     * @see {@link https://e621.wiki/#operations-Forum_Topics-unsubscribeForumTopic Documentation} for more details.
+     */
+    async unsubscribe(id) {
+        return unsubscribeForumTopic({
+            client: this.client,
+            path: { id }
+        }).then(res => this._handleResponse(res, 201, true, ForumTopic));
+    }
+}
+__decorate([
+    OperationID("createForumTopic"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ForumTopics.prototype, "create", null);
+__decorate([
+    OperationID("deleteForumTopic"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", Promise)
+], ForumTopics.prototype, "delete", null);
+__decorate([
+    OperationID("editForumTopic"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number, Object]),
+    __metadata("design:returntype", Promise)
+], ForumTopics.prototype, "edit", null);
+__decorate([
+    OperationID("getForumTopic"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", Promise)
+], ForumTopics.prototype, "get", null);
+__decorate([
+    OperationID("hideForumTopic"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", Promise)
+], ForumTopics.prototype, "hide", null);
+__decorate([
+    OperationID("markAllForumTopicsAsRead"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], ForumTopics.prototype, "markAllRead", null);
+__decorate([
+    OperationID("searchForumTopics"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], ForumTopics.prototype, "search", null);
+__decorate([
+    OperationID("subscribeForumTopic"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", Promise)
+], ForumTopics.prototype, "subscribe", null);
+__decorate([
+    OperationID("unhideForumTopic"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", Promise)
+], ForumTopics.prototype, "unhide", null);
+__decorate([
+    OperationID("unsubscribeForumTopic"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Number]),
+    __metadata("design:returntype", Promise)
+], ForumTopics.prototype, "unsubscribe", null);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRm9ydW1Ub3BpY3MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9saWIvbW9kdWxlcy9Gb3J1bVRvcGljcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsT0FBTyxJQUFJLE1BQU0sV0FBVyxDQUFDO0FBQzdCLE9BQU8sRUFDSCxnQkFBZ0IsRUFDaEIsZ0JBQWdCLEVBQ2hCLGNBQWMsRUFDZCxhQUFhLEVBQ2IsY0FBYyxFQUNkLHdCQUF3QixFQUN4QixpQkFBaUIsRUFDakIsbUJBQW1CLEVBQ25CLGdCQUFnQixFQUNoQixxQkFBcUIsRUFDeEIsTUFBTSxxQkFBcUIsQ0FBQztBQUU3QixPQUFPLEVBQUUsV0FBVyxFQUFFLFVBQVUsRUFBb0MsTUFBTSxZQUFZLENBQUM7QUFDdkYsT0FBTyxVQUFVLE1BQU0seUJBQXlCLENBQUM7QUFnQmpELHdCQUF3QjtBQUN4QixNQUFNLENBQUMsT0FBTyxPQUFPLFdBQVksU0FBUSxJQUFJO0lBQ3pDOzs7Ozs7OztPQVFBO0lBRU0sQUFBTixLQUFLLENBQUMsTUFBTSxDQUFDLE9BQTBCO1FBQ25DLE9BQU8sZ0JBQWdCLENBQUM7WUFDcEIsTUFBTSxFQUFFLElBQUksQ0FBQyxNQUFNO1lBQ25CLElBQUksRUFBSTtnQkFDSiwwQkFBMEIsRUFBcUIsT0FBTyxDQUFDLFdBQVc7Z0JBQ2xFLHdCQUF3QixFQUF1QixPQUFPLENBQUMsU0FBUztnQkFDaEUsd0JBQXdCLEVBQXVCLE9BQU8sQ0FBQyxTQUFTO2dCQUNoRSw2Q0FBNkMsRUFBRSxPQUFPLENBQUMsd0JBQXdCLEVBQUUsSUFBSTtnQkFDckYsMkNBQTJDLEVBQUksT0FBTyxDQUFDLHdCQUF3QixFQUFFLEVBQUU7Z0JBQ25GLG9CQUFvQixFQUEyQixPQUFPLENBQUMsS0FBSzthQUMvRDtTQUNKLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsSUFBSSxFQUFFLFVBQVUsQ0FBQyxDQUFDLENBQUM7SUFDckUsQ0FBQztJQUVEOzs7Ozs7Ozs7O09BVUE7SUFFTSxBQUFOLEtBQUssQ0FBQyxNQUFNLENBQUMsRUFBVTtRQUNuQixPQUFPLGdCQUFnQixDQUFDO1lBQ3BCLE1BQU0sRUFBRSxJQUFJLENBQUMsTUFBTTtZQUNuQixJQUFJLEVBQUksRUFBRSxFQUFFLEVBQUU7U0FDakIsQ0FBQyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsR0FBRyxFQUFFLEdBQUcsRUFBRSxJQUFJLENBQUMsQ0FBQyxDQUFDO0lBQ3pELENBQUM7SUFFRDs7Ozs7Ozs7T0FRQTtJQUVNLEFBQU4sS0FBSyxDQUFDLElBQUksQ0FBQyxFQUFVLEVBQUUsT0FBMEI7UUFDN0MsT0FBTyxjQUFjLENBQUM7WUFDbEIsTUFBTSxFQUFFLElBQUksQ0FBQyxNQUFNO1lBQ25CLElBQUksRUFBSSxFQUFFLEVBQUUsRUFBRTtZQUNkLElBQUksRUFBSTtnQkFDSiwwQkFBMEIsRUFBcUIsT0FBTyxDQUFDLFdBQVc7Z0JBQ2xFLHdCQUF3QixFQUF1QixPQUFPLENBQUMsU0FBUztnQkFDaEUsd0JBQXdCLEVBQXVCLE9BQU8sQ0FBQyxTQUFTO2dCQUNoRSw2Q0FBNkMsRUFBRSxPQUFPLENBQUMsd0JBQXdCLEVBQUUsSUFBSTtnQkFDckYsMkNBQTJDLEVBQUksT0FBTyxDQUFDLHdCQUF3QixFQUFFLEVBQUU7Z0JBQ25GLG9CQUFvQixFQUEyQixPQUFPLENBQUMsS0FBSzthQUMvRDtTQUNKLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsSUFBSSxDQUFDLENBQUMsQ0FBQztJQUN6RCxDQUFDO0lBRUQ7Ozs7Ozs7O09BUUE7SUFFTSxBQUFOLEtBQUssQ0FBQyxHQUFHLENBQUMsRUFBVTtRQUNoQixPQUFPLGFBQWEsQ0FBQztZQUNqQixNQUFNLEVBQUUsSUFBSSxDQUFDLE1BQU07WUFDbkIsSUFBSSxFQUFJLEVBQUUsRUFBRSxFQUFFO1NBQ2pCLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsS0FBSyxFQUFFLFVBQVUsQ0FBQyxDQUFDLENBQUM7SUFDdEUsQ0FBQztJQUVEOzs7Ozs7Ozs7O09BVUE7SUFFTSxBQUFOLEtBQUssQ0FBQyxJQUFJLENBQUMsRUFBVTtRQUNqQixPQUFPLGNBQWMsQ0FBQztZQUNsQixNQUFNLEVBQUUsSUFBSSxDQUFDLE1BQU07WUFDbkIsSUFBSSxFQUFJLEVBQUUsRUFBRSxFQUFFO1NBQ2pCLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsSUFBSSxFQUFFLFVBQVUsQ0FBQyxDQUFDLENBQUM7SUFDckUsQ0FBQztJQUVEOzs7Ozs7OztPQVFBO0lBRU0sQUFBTixLQUFLLENBQUMsV0FBVztRQUNiLE9BQU8sd0JBQXdCLENBQUM7WUFDNUIsTUFBTSxFQUFFLElBQUksQ0FBQyxNQUFNO1NBQ3RCLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsSUFBSSxDQUFDLENBQUMsQ0FBQztJQUN6RCxDQUFDO0lBRUQ7Ozs7OztPQU1BO0lBRU0sQUFBTixLQUFLLENBQUMsTUFBTSxDQUFDLE9BQWtDO1FBQzNDLE9BQU8saUJBQWlCLENBQUM7WUFDckIsTUFBTSxFQUFFLElBQUksQ0FBQyxNQUFNO1lBQ25CLEtBQUssRUFBRyxVQUFVLENBQUMsT0FBTyxFQUFFLFFBQVEsRUFBRSxDQUFDLE9BQU8sRUFBRSxNQUFNLENBQUMsQ0FBQztTQUMzRCxDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLElBQUksRUFBRSxVQUFVLENBQUMsQ0FBQyxDQUFDO0lBQ3JFLENBQUM7SUFFRDs7Ozs7Ozs7T0FRQTtJQUVNLEFBQU4sS0FBSyxDQUFDLFNBQVMsQ0FBQyxFQUFVO1FBQ3RCLE9BQU8sbUJBQW1CLENBQUM7WUFDdkIsTUFBTSxFQUFFLElBQUksQ0FBQyxNQUFNO1lBQ25CLElBQUksRUFBSSxFQUFFLEVBQUUsRUFBRTtTQUNqQixDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLElBQUksRUFBRSxVQUFVLENBQUMsQ0FBQyxDQUFDO0lBQ3JFLENBQUM7SUFFRDs7Ozs7Ozs7OztPQVVBO0lBRU0sQUFBTixLQUFLLENBQUMsTUFBTSxDQUFDLEVBQVU7UUFDbkIsT0FBTyxnQkFBZ0IsQ0FBQztZQUNwQixNQUFNLEVBQUUsSUFBSSxDQUFDLE1BQU07WUFDbkIsSUFBSSxFQUFJLEVBQUUsRUFBRSxFQUFFO1NBQ2pCLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsSUFBSSxFQUFFLFVBQVUsQ0FBQyxDQUFDLENBQUM7SUFDckUsQ0FBQztJQUVEOzs7Ozs7OztPQVFBO0lBRU0sQUFBTixLQUFLLENBQUMsV0FBVyxDQUFDLEVBQVU7UUFDeEIsT0FBTyxxQkFBcUIsQ0FBQztZQUN6QixNQUFNLEVBQUUsSUFBSSxDQUFDLE1BQU07WUFDbkIsSUFBSSxFQUFJLEVBQUUsRUFBRSxFQUFFO1NBQ2pCLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsSUFBSSxFQUFFLFVBQVUsQ0FBQyxDQUFDLENBQUM7SUFDckUsQ0FBQztDQUNKO0FBakxTO0lBRFIsV0FBVyxDQUFDLGtCQUFrQixDQUFDOzs7O3lDQWE1QjtBQWNLO0lBRFIsV0FBVyxDQUFDLGtCQUFrQixDQUFDOzs7O3lDQU01QjtBQVlLO0lBRFIsV0FBVyxDQUFDLGdCQUFnQixDQUFDOzs7O3VDQWMxQjtBQVlLO0lBRFIsV0FBVyxDQUFDLGVBQWUsQ0FBQzs7OztzQ0FNekI7QUFjSztJQURSLFdBQVcsQ0FBQyxnQkFBZ0IsQ0FBQzs7Ozt1Q0FNMUI7QUFZSztJQURSLFdBQVcsQ0FBQywwQkFBMEIsQ0FBQzs7Ozs4Q0FLcEM7QUFVSztJQURSLFdBQVcsQ0FBQyxtQkFBbUIsQ0FBQzs7Ozt5Q0FNN0I7QUFZSztJQURSLFdBQVcsQ0FBQyxxQkFBcUIsQ0FBQzs7Ozs0Q0FNL0I7QUFjSztJQURSLFdBQVcsQ0FBQyxrQkFBa0IsQ0FBQzs7Ozt5Q0FNNUI7QUFZSztJQURSLFdBQVcsQ0FBQyx1QkFBdUIsQ0FBQzs7Ozs4Q0FNakMifQ==