e621 1.0.9 → 2.0.0-dev.11

package/build/src/modules/UserFeedback.js

@@ -0,0 +1,134 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const FormHelper_1 = __importDefault(require("../util/FormHelper"));
+const RequestHandler_1 = require("../util/RequestHandler");
+class UserFeedback {
+    auth;
+    main;
+    constructor(main) {
+        Object.defineProperties(this, {
+            auth: {
+                get() {
+                    return !this.main.options.authUser || !this.main.options.authKey ? null : `Basic ${Buffer.from(`${this.main.options.authUser}:${this.main.options.authKey}`).toString("base64")}`;
+                },
+                configurable: false,
+                enumerable: false
+            },
+            main: {
+                value: main,
+                configurable: false,
+                enumerable: false,
+                writable: false
+            }
+        });
+    }
+    /**
+     * Get a specific user feedback
+     *
+     * @param {number} id - The id of the feedback to fetch
+     * @returns {Promise<(UserFeedbackProperties | null)>}
+     */
+    async get(id) {
+        const res = await this.main.request.get(`/user_feedbacks/${id}.json`).catch(err => {
+            if (err instanceof RequestHandler_1.APIError && err.statusCode === 404)
+                return null;
+            throw err;
+        });
+        return res;
+    }
+    /**
+     * Search for user feedback
+     *
+     * @param {object} [options]
+     * @param {string} [options.username] - narrow the search by a specific target
+     * @param {string} [options.creator] - narrow the search by a specific creator
+     * @param {string} [options.body] - narrow the search by the content of the feedback
+     * @param {FeedbackCategories} [options.category] - narrow the search by the type
+     * @param {(number |`${"" | "a" | "b"}${number}`)} - page of results to get
+     * @param {number} [options.limit] - limit the maximum returned results
+     * @returns {Promise<Array<UserFeedbackProperties>>}
+     */
+    async search(options) {
+        options = options ?? {};
+        const qs = new FormHelper_1.default();
+        if (typeof options.username === "string")
+            qs.add("search[user_name]", options.username);
+        if (typeof options.creator === "string")
+            qs.add("search[creator_name]", options.creator);
+        if (typeof options.body === "string")
+            qs.add("search[body_matches]", options.body);
+        if (typeof options.category === "string")
+            qs.add("search[category]", options.category);
+        if (typeof options.page !== "undefined")
+            qs.add("page", options.page);
+        if (typeof options.limit === "number")
+            qs.add("limit", options.limit);
+        const res = await this.main.request.get(`/user_feedbacks.json?${qs.build()}`);
+        return res;
+    }
+    /**
+     * Add feedback to a user
+     *
+     * * Requires Authentication
+     *
+     * * Requires Moderator
+     *
+     * @param {object} options
+     * @param {string} options.username - the user the feedback is for
+     * @param {FeedbackCategories} options.category - the type of feedback
+     * @param {string} options.body - the content of the feedback
+     * @returns {Promise<UserFeedbackProperties>}
+     */
+    async create(options) {
+        this.main.request.authCheck.call(this, "UserFeedback#create");
+        const qs = new FormHelper_1.default()
+            .add("user_feedback[user_name]", options.username)
+            .add("user_feedback[category]", options.category)
+            .add("user_feedback[body]", options.body);
+        const res = await this.main.request.post("/user_feedbacks.json", qs.build());
+        return res;
+    }
+    /**
+     * Modify an existing user feedback
+     *
+     * * Requires Authentication
+     *
+     * * Requires Moderator
+     *
+     * @param {number} id - the id of the feedback to edit
+     * @param {object} options
+     * @param {string} [options.body] - the content of the feedback
+     * @param {FeedbackCategories} [options.category] - the type of feedback
+     * @returns {Promise<UserFeedbackProperties>}
+     */
+    async modify(id, options) {
+        this.main.request.authCheck.call(this, "UserFeedback#modify");
+        const qs = new FormHelper_1.default();
+        if (options.body)
+            qs.add("user_feedback[body]", options.body);
+        if (options.category)
+            qs.add("user_feedback[category]", options.category);
+        const res = await this.main.request.patch(`/user_feedbacks/${id}.json`, qs.build());
+        return res;
+    }
+    /**
+     * Delete an existing user feedback
+     *
+     * * Requires Authentication
+     *
+     * * Requires Moderator
+     *
+     * @param {number} id - the id of the feedback to delete
+     * @returns {Promise<null>}
+     */
+    async delete(id) {
+        this.main.request.authCheck.call(this, "UserFeedback#delete");
+        const res = await this.main.request.delete(`/user_feedbacks/${id}.json`);
+        return res;
+    }
+}
+exports.default = UserFeedback;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVXNlckZlZWRiYWNrLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL21vZHVsZXMvVXNlckZlZWRiYWNrLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBUUEsb0VBQTRDO0FBQzVDLDJEQUFrRDtBQUVsRCxNQUFxQixZQUFZO0lBQ2YsSUFBSSxDQUFnQjtJQUNwQixJQUFJLENBQU87SUFDNUIsWUFBWSxJQUFVO1FBQ3JCLE1BQU0sQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLEVBQUU7WUFDN0IsSUFBSSxFQUFFO2dCQUNMLEdBQUc7b0JBQ0YsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFFBQVEsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxTQUFTLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxRQUFRLElBQUksSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLEVBQUUsQ0FBQztnQkFDbkwsQ0FBQztnQkFDRCxZQUFZLEVBQUUsS0FBSztnQkFDbkIsVUFBVSxFQUFFLEtBQUs7YUFDakI7WUFDRCxJQUFJLEVBQUU7Z0JBQ0wsS0FBSyxFQUFFLElBQUk7Z0JBQ1gsWUFBWSxFQUFFLEtBQUs7Z0JBQ25CLFVBQVUsRUFBRSxLQUFLO2dCQUNqQixRQUFRLEVBQUUsS0FBSzthQUNmO1NBQ0QsQ0FBQyxDQUFDO0lBQ0osQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsS0FBSyxDQUFDLEdBQUcsQ0FBQyxFQUFVO1FBQ25CLE1BQU0sR0FBRyxHQUFHLE1BQU0sSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUF5QixtQkFBbUIsRUFBRSxPQUFPLENBQUMsQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLEVBQUU7WUFDekcsSUFBSSxHQUFHLFlBQVkseUJBQVEsSUFBSSxHQUFHLENBQUMsVUFBVSxLQUFLLEdBQUc7Z0JBQUUsT0FBTyxJQUFJLENBQUM7WUFDbkUsTUFBTSxHQUFHLENBQUM7UUFDWCxDQUFDLENBQUMsQ0FBQztRQUNILE9BQU8sR0FBRyxDQUFDO0lBQ1osQ0FBQztJQUVEOzs7Ozs7Ozs7OztPQVdHO0lBQ0gsS0FBSyxDQUFDLE1BQU0sQ0FBQyxPQUFtQztRQUMvQyxPQUFPLEdBQUcsT0FBTyxJQUFJLEVBQUUsQ0FBQztRQUN4QixNQUFNLEVBQUUsR0FBRyxJQUFJLG9CQUFVLEVBQUUsQ0FBQztRQUM1QixJQUFJLE9BQU8sT0FBTyxDQUFDLFFBQVEsS0FBSyxRQUFRO1lBQUssRUFBRSxDQUFDLEdBQUcsQ0FBQyxtQkFBbUIsRUFBRSxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDM0YsSUFBSSxPQUFPLE9BQU8sQ0FBQyxPQUFPLEtBQU0sUUFBUTtZQUFLLEVBQUUsQ0FBQyxHQUFHLENBQUMsc0JBQXNCLEVBQUUsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQzdGLElBQUksT0FBTyxPQUFPLENBQUMsSUFBSSxLQUFTLFFBQVE7WUFBSyxFQUFFLENBQUMsR0FBRyxDQUFDLHNCQUFzQixFQUFFLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUMxRixJQUFJLE9BQU8sT0FBTyxDQUFDLFFBQVEsS0FBSyxRQUFRO1lBQUssRUFBRSxDQUFDLEdBQUcsQ0FBQyxrQkFBa0IsRUFBRSxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDMUYsSUFBSSxPQUFPLE9BQU8sQ0FBQyxJQUFJLEtBQVMsV0FBVztZQUFFLEVBQUUsQ0FBQyxHQUFHLENBQUMsTUFBTSxFQUFFLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUMxRSxJQUFJLE9BQU8sT0FBTyxDQUFDLEtBQUssS0FBUSxRQUFRO1lBQUssRUFBRSxDQUFDLEdBQUcsQ0FBQyxPQUFPLEVBQUUsT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDO1FBQzVFLE1BQU0sR0FBRyxHQUFHLE1BQU0sSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFnQyx3QkFBd0IsRUFBRSxDQUFDLEtBQUssRUFBRSxFQUFFLENBQUMsQ0FBQztRQUM3RyxPQUFPLEdBQUksQ0FBQztJQUNiLENBQUM7SUFFRDs7Ozs7Ozs7Ozs7O09BWUc7SUFDSCxLQUFLLENBQUMsTUFBTSxDQUFDLE9BQWtDO1FBQzlDLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsSUFBSSxFQUFFLHFCQUFxQixDQUFDLENBQUM7UUFDOUQsTUFBTSxFQUFFLEdBQUcsSUFBSSxvQkFBVSxFQUFFO2FBQ3pCLEdBQUcsQ0FBQywwQkFBMEIsRUFBRSxPQUFPLENBQUMsUUFBUSxDQUFDO2FBQ2pELEdBQUcsQ0FBQyx5QkFBeUIsRUFBRSxPQUFPLENBQUMsUUFBUSxDQUFDO2FBQ2hELEdBQUcsQ0FBQyxxQkFBcUIsRUFBRSxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDM0MsTUFBTSxHQUFHLEdBQUcsTUFBTSxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQXlCLHNCQUFzQixFQUFFLEVBQUUsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxDQUFDO1FBQ3JHLE9BQU8sR0FBSSxDQUFDO0lBQ2IsQ0FBQztJQUVEOzs7Ozs7Ozs7Ozs7T0FZRztJQUNILEtBQUssQ0FBQyxNQUFNLENBQUMsRUFBVSxFQUFFLE9BQWtDO1FBQzFELElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsSUFBSSxFQUFFLHFCQUFxQixDQUFDLENBQUM7UUFDOUQsTUFBTSxFQUFFLEdBQUcsSUFBSSxvQkFBVSxFQUFFLENBQUM7UUFDNUIsSUFBSSxPQUFPLENBQUMsSUFBSTtZQUFFLEVBQUUsQ0FBQyxHQUFHLENBQUMscUJBQXFCLEVBQUUsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQzlELElBQUksT0FBTyxDQUFDLFFBQVE7WUFBRSxFQUFFLENBQUMsR0FBRyxDQUFDLHlCQUF5QixFQUFFLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUMxRSxNQUFNLEdBQUcsR0FBRyxNQUFNLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBeUIsbUJBQW1CLEVBQUUsT0FBTyxFQUFFLEVBQUUsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxDQUFDO1FBQzVHLE9BQU8sR0FBSSxDQUFDO0lBQ2IsQ0FBQztJQUVEOzs7Ozs7Ozs7T0FTRztJQUNILEtBQUssQ0FBQyxNQUFNLENBQUMsRUFBVTtRQUN0QixJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLElBQUksRUFBRSxxQkFBcUIsQ0FBQyxDQUFDO1FBQzlELE1BQU0sR0FBRyxHQUFHLE1BQU0sSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFPLG1CQUFtQixFQUFFLE9BQU8sQ0FBQyxDQUFDO1FBQy9FLE9BQU8sR0FBRyxDQUFDO0lBQ1osQ0FBQztDQUNEO0FBeEhELCtCQXdIQyJ9

package/build/src/modules/Users.d.ts

@@ -0,0 +1,110 @@
+import type E621 from "..";
+import AuthenticatedUser from "../structures/AuthenticatedUser";
+import Post from "../structures/Post";
+import User from "../structures/User";
+import type { UploadLimit, SearchUsersOptions, EditSelfUserOptions } from "../types";
+export default class Users {
+    private readonly auth;
+    private readonly main;
+    constructor(main: E621);
+    /**
+     * Get a user by their id or username
+     *
+     * Use `getSelf` to get the currently authenticated user
+     *
+     * @param {(number | string)} idOrname - The id or username of the user to get
+     * @returns {Promise<(User | null)>}
+     */
+    get(idOrName: number | string): Promise<User | null>;
+    /**
+     * Search for users
+     *
+     * @param {object} [options]
+     * @param {string} [options.name] - narrow the search by usernames
+     * @param {string} [options.email] - narrow the search by email (requires elevated privileges)
+     * @param {number} [options.level] - narrow the search by user level
+     * @param {number} [options.minLevel] - narrow the search by minimum user level
+     * @param {number} [options.maxLevel] - narrow the search by maximum user level
+     * @param {boolean} [options.unrestrictedUploads] - narrow the search by unrestricted uploaders
+     * @param {boolean} [options.approver] - narrow the search by approvers
+     * @param {UserOrder} [options.order] - order the search results
+     * @param {(number |`${"" | "a" | "b"}${number}`)} - page to get
+     * @param {number} [options.limit] - limit the maximum amount of results returned
+     * @returns {Promise<Array<User>>}
+     */
+    search(options?: SearchUsersOptions): Promise<User[]>;
+    /**
+     * Get the currently authenticated user
+     *
+     * * Authentication Required
+     *
+     * @returns {Promise<AuthenticatedUser>}
+     */
+    getSelf(): Promise<AuthenticatedUser>;
+    /**
+     * Edit the authenticated user
+     *
+     * * Requires Authentication
+     *
+     * @param {object} options
+     * @param {(number | null)} [options.avatarID] - post id to use as avatar
+     * @param {string} [options.about] - about section
+     * @param {string} [options.artinfo] - commissions section
+     * @param {Timezones} [options.timezone] - timezone
+     * @param {boolean} [options.receiveEmailNotifications] - if you should receive notifications via email
+     * @param {number} [options.commentThreshold] - the threshold at which comments should be hidden (usually negative)
+     * @param {DefaultImageSize} [options.defaultImageSize] - default image display size
+     * @param {number} [options.postsPerPage] - default posts per page, between 25 and 250
+     * @param {boolean} [options.safeMode] - toggle safe mode
+     * @param {(Array<string> | string)} [options.blacklistedTags] - the list of tags to hide in searches
+     * @param {boolean} [options.blacklistUsers] - hide things from users that have been blocked from the site
+     * @param {boolean} [options.coloredUsernames] - Color each user's name depending on their level. See the [legend](https://e621.net/wiki_pages/e621:colored_usernames) for what the colors are.
+     * @param {boolean} [options.enableKeyboardShortcuts] - Enables the use of keyboard shortcuts for a majority of site actions related to posts. A list of keyboard shortcuts is available [here](https://e621.net/static/keyboard_shortcuts).
+     * @param {boolean} [options.enableAutoComplete] - Enables auto-completion on most tag and user entry fields.
+     * @param {boolean} [options.enablePrivacyMode] - Makes a cursory effort to prevent showing your favorites to others users. Has not been well tested.
+     * @param {boolean} [options.enablePostStatistics] - Show post statistics below posts on search pages.
+     * @param {boolean} [options.descriptionCollapsed] - Don't expand post descriptions on page load.
+     * @param {boolean} [options.hideComments] - Do not show the comments section on post pages.
+     * @param {boolean} [options.disableCroppedThumbnails] - Prevent other users from sending you DMails. You will be prevented from sending DMails to non-staff members while this option is enabled. Staff are always allowed to send you DMails.
+     * @param {boolean} [options.showOwnHiddenComments] - Disables displaying cropped thumbnails on the mobile layout of the site in favor of scaled thumbnails. Has no effect on the desktop site.
+     * @param {boolean} [options.enableCompactUploader] - Show your own hidden comments on comment pages.
+     * @param {string} [options.dmailFilter] - A list of banned words (space delimited). Any dmail you receive with a banned word will automatically be deleted.
+     * @param {string} [options.frequentTags] - A list of tags that you use often. They will appear when using the list of Related Tags.
+     * @param {boolean} [options.disableResponsiveMode] - Disable alternative layout for mobile and tablet.
+     * @param {string} [options.customCSSStyle] - Style to apply to the whole site.
+     * @returns {Promise<null>}
+     */
+    editSelf(options: EditSelfUserOptions): Promise<null>;
+    /**
+     * Get the authenticated user's /users/upload_limit (best way I can find to find out who you are)
+     *
+     * * Authentication Required
+     *
+     * @returns {Promise<UploadLimit>}
+     */
+    getUploadLimit(): Promise<UploadLimit>;
+    /**
+     * Get the favorites of a user
+     *
+     * @param {number} [id] - the id of the user to get favorites for, or none to get the authenticated user, if provided
+     */
+    getFavorites(id?: number): Promise<Post[]>;
+    /**
+     * Add a favorite
+     *
+     * * Requires Authentication
+     *
+     * @param {number} id - the id of the post to favorite
+     * @returns {Promise<Post>}
+     */
+    addFavorite(id: number): Promise<Post>;
+    /**
+     * Remove a favorite
+     *
+     * * Requires Authentication
+     *
+     * @param {number} id - the id of the post to unfavorite
+     * @returns {Promise<null>}
+     */
+    removeFavorite(id: number): Promise<null>;
+}

package/build/src/modules/Users.js

@@ -0,0 +1,248 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const AuthenticatedUser_1 = __importDefault(require("../structures/AuthenticatedUser"));
+const Post_1 = __importDefault(require("../structures/Post"));
+const User_1 = __importDefault(require("../structures/User"));
+const FormHelper_1 = __importDefault(require("../util/FormHelper"));
+const RequestHandler_1 = require("../util/RequestHandler");
+class Users {
+    auth;
+    main;
+    constructor(main) {
+        Object.defineProperties(this, {
+            auth: {
+                get() {
+                    return !this.main.options.authUser || !this.main.options.authKey ? null : `Basic ${Buffer.from(`${this.main.options.authUser}:${this.main.options.authKey}`).toString("base64")}`;
+                },
+                configurable: false,
+                enumerable: false
+            },
+            main: {
+                value: main,
+                configurable: false,
+                enumerable: false,
+                writable: false
+            }
+        });
+    }
+    /**
+     * Get a user by their id or username
+     *
+     * Use `getSelf` to get the currently authenticated user
+     *
+     * @param {(number | string)} idOrname - The id or username of the user to get
+     * @returns {Promise<(User | null)>}
+     */
+    async get(idOrName) {
+        const res = await this.main.request.get(`/users/${idOrName}.json`).catch(err => {
+            if (err instanceof RequestHandler_1.APIError && err.statusCode === 404)
+                return null;
+            throw err;
+        });
+        return res === null ? null : new User_1.default(this.main, res);
+    }
+    /**
+     * Search for users
+     *
+     * @param {object} [options]
+     * @param {string} [options.name] - narrow the search by usernames
+     * @param {string} [options.email] - narrow the search by email (requires elevated privileges)
+     * @param {number} [options.level] - narrow the search by user level
+     * @param {number} [options.minLevel] - narrow the search by minimum user level
+     * @param {number} [options.maxLevel] - narrow the search by maximum user level
+     * @param {boolean} [options.unrestrictedUploads] - narrow the search by unrestricted uploaders
+     * @param {boolean} [options.approver] - narrow the search by approvers
+     * @param {UserOrder} [options.order] - order the search results
+     * @param {(number |`${"" | "a" | "b"}${number}`)} - page to get
+     * @param {number} [options.limit] - limit the maximum amount of results returned
+     * @returns {Promise<Array<User>>}
+     */
+    async search(options) {
+        options = options ?? {};
+        const qs = new FormHelper_1.default();
+        if (typeof options.name === "string")
+            qs.add("search[name_matches]", options.name);
+        if (typeof options.email === "string")
+            qs.add("search[email_matches]", options.email);
+        if (typeof options.level === "number")
+            qs.add("search[level]", options.level);
+        if (typeof options.minLevel === "number")
+            qs.add("search[min_level]", options.minLevel);
+        if (typeof options.maxLevel === "number")
+            qs.add("search[max_level]", options.maxLevel);
+        if (typeof options.unrestrictedUploads === "boolean")
+            qs.add("search[can_upload_free]", options.unrestrictedUploads);
+        if (typeof options.approver === "boolean")
+            qs.add("search[can_approve_posts]", options.approver);
+        if (typeof options.order === "string")
+            qs.add("search[order]", options.order);
+        if (typeof options.page !== "undefined")
+            qs.add("page", options.page);
+        if (typeof options.limit === "number")
+            qs.add("limit", options.limit);
+        const res = await this.main.request.get(`/user_feedbacks.json?${qs.build()}`);
+        return res.map(info => new User_1.default(this.main, info));
+    }
+    /**
+     * Get the currently authenticated user
+     *
+     * * Authentication Required
+     *
+     * @returns {Promise<AuthenticatedUser>}
+     */
+    async getSelf() {
+        this.main.request.authCheck.call(this, "Users#getSelf");
+        const { id } = await this.getUploadLimit();
+        const res = await this.main.request.get(`/users/${id}.json`);
+        return new AuthenticatedUser_1.default(this.main, res);
+    }
+    /**
+     * Edit the authenticated user
+     *
+     * * Requires Authentication
+     *
+     * @param {object} options
+     * @param {(number | null)} [options.avatarID] - post id to use as avatar
+     * @param {string} [options.about] - about section
+     * @param {string} [options.artinfo] - commissions section
+     * @param {Timezones} [options.timezone] - timezone
+     * @param {boolean} [options.receiveEmailNotifications] - if you should receive notifications via email
+     * @param {number} [options.commentThreshold] - the threshold at which comments should be hidden (usually negative)
+     * @param {DefaultImageSize} [options.defaultImageSize] - default image display size
+     * @param {number} [options.postsPerPage] - default posts per page, between 25 and 250
+     * @param {boolean} [options.safeMode] - toggle safe mode
+     * @param {(Array<string> | string)} [options.blacklistedTags] - the list of tags to hide in searches
+     * @param {boolean} [options.blacklistUsers] - hide things from users that have been blocked from the site
+     * @param {boolean} [options.coloredUsernames] - Color each user's name depending on their level. See the [legend](https://e621.net/wiki_pages/e621:colored_usernames) for what the colors are.
+     * @param {boolean} [options.enableKeyboardShortcuts] - Enables the use of keyboard shortcuts for a majority of site actions related to posts. A list of keyboard shortcuts is available [here](https://e621.net/static/keyboard_shortcuts).
+     * @param {boolean} [options.enableAutoComplete] - Enables auto-completion on most tag and user entry fields.
+     * @param {boolean} [options.enablePrivacyMode] - Makes a cursory effort to prevent showing your favorites to others users. Has not been well tested.
+     * @param {boolean} [options.enablePostStatistics] - Show post statistics below posts on search pages.
+     * @param {boolean} [options.descriptionCollapsed] - Don't expand post descriptions on page load.
+     * @param {boolean} [options.hideComments] - Do not show the comments section on post pages.
+     * @param {boolean} [options.disableCroppedThumbnails] - Prevent other users from sending you DMails. You will be prevented from sending DMails to non-staff members while this option is enabled. Staff are always allowed to send you DMails.
+     * @param {boolean} [options.showOwnHiddenComments] - Disables displaying cropped thumbnails on the mobile layout of the site in favor of scaled thumbnails. Has no effect on the desktop site.
+     * @param {boolean} [options.enableCompactUploader] - Show your own hidden comments on comment pages.
+     * @param {string} [options.dmailFilter] - A list of banned words (space delimited). Any dmail you receive with a banned word will automatically be deleted.
+     * @param {string} [options.frequentTags] - A list of tags that you use often. They will appear when using the list of Related Tags.
+     * @param {boolean} [options.disableResponsiveMode] - Disable alternative layout for mobile and tablet.
+     * @param {string} [options.customCSSStyle] - Style to apply to the whole site.
+     * @returns {Promise<null>}
+     */
+    async editSelf(options) {
+        this.main.request.authCheck.call(this, "Users#editSelf");
+        if (!options)
+            throw new Error("options is required for Users#editSelf");
+        const qs = new FormHelper_1.default();
+        if (options.avatarID === null || typeof options.avatarID === "string")
+            qs.add("user[avatar_id]", options.avatarID || "");
+        if (typeof options.about === "string")
+            qs.add("user[profile_about]", options.about);
+        if (typeof options.artinfo === "string")
+            qs.add("user[profile_artinfo]", options.artinfo);
+        if (typeof options.timezone === "string")
+            qs.add("user[time_zone]", options.timezone);
+        if (typeof options.receiveEmailNotifications === "boolean")
+            qs.add("user[receive_email_notifications]", options.receiveEmailNotifications);
+        if (typeof options.commentThreshold === "number")
+            qs.add("user[comment_threshold]", options.commentThreshold);
+        if (typeof options.defaultImageSize === "number" && options.defaultImageSize >= 25 && options.defaultImageSize <= 250)
+            qs.add("user[default_image_size]", options.defaultImageSize);
+        if (typeof options.postsPerPage === "number")
+            qs.add("user[per_page]", options.postsPerPage);
+        if (typeof options.safeMode === "boolean")
+            qs.add("user[enable_safe_mode]", options.safeMode);
+        if (typeof options.blacklistedTags === "string" || Array.isArray(options.blacklistedTags))
+            qs.add("user[blacklisted_tags]", Array.isArray(options.blacklistedTags) ? options.blacklistedTags.join("\n") : options.blacklistedTags);
+        if (typeof options.blacklistUsers === "boolean")
+            qs.add("user[blacklist_users]", options.blacklistUsers);
+        // Advanced
+        if (typeof options.coloredUsernames === "boolean")
+            qs.add("user[style_usernames]", options.coloredUsernames);
+        if (typeof options.enableKeyboardShortcuts === "boolean")
+            qs.add("user[enable_keyboard_navigation]", options.enableKeyboardShortcuts);
+        if (typeof options.enableAutoComplete === "boolean")
+            qs.add("user[enable_auto_complete]", options.enableAutoComplete);
+        if (typeof options.enablePrivacyMode === "boolean")
+            qs.add("user[enable_privacy_mode]", options.enablePrivacyMode);
+        if (typeof options.enablePostStatistics === "boolean")
+            qs.add("user[show_post_statistics]", options.enablePostStatistics);
+        if (typeof options.descriptionCollapsed === "boolean")
+            qs.add("user[description_collapsed_initially]", options.descriptionCollapsed);
+        if (typeof options.hideComments === "boolean")
+            qs.add("user[hide_comments]", options.hideComments);
+        if (typeof options.disableCroppedThumbnails === "boolean")
+            qs.add("user[disable_cropped_thumbnails]", options.disableCroppedThumbnails);
+        if (typeof options.showOwnHiddenComments === "boolean")
+            qs.add("user[show_hidden_comments]", options.showOwnHiddenComments);
+        if (typeof options.enableCompactUploader === "boolean")
+            qs.add("user[enable_compact_uploader]", options.enableCompactUploader);
+        if (typeof options.dmailFilter === "string")
+            qs.add("user[dmail_filter_attributes][words]", options.dmailFilter);
+        if (typeof options.frequentTags === "string")
+            qs.add("user[favorite_tags]", options.frequentTags);
+        if (typeof options.disableResponsiveMode === "boolean")
+            qs.add("user[disable_responsive_mode]", options.disableResponsiveMode);
+        if (typeof options.customCSSStyle === "string")
+            qs.add("user[custom_style]", options.customCSSStyle);
+        //                                             any id goes to to the current user
+        const res = await this.main.request.patch("/users/0.json", qs.build());
+        return res;
+    }
+    /**
+     * Get the authenticated user's /users/upload_limit (best way I can find to find out who you are)
+     *
+     * * Authentication Required
+     *
+     * @returns {Promise<UploadLimit>}
+     */
+    async getUploadLimit() {
+        this.main.request.authCheck.call(this, "Users#getUploadLimit");
+        const res = await this.main.request.get("/users/upload_limit.json");
+        return res;
+    }
+    /**
+     * Get the favorites of a user
+     *
+     * @param {number} [id] - the id of the user to get favorites for, or none to get the authenticated user, if provided
+     */
+    async getFavorites(id) {
+        if (!id) {
+            const auth = this.main.request.authCheck.call(this, "Users#getFavorites", false);
+            if (!auth)
+                throw new Error("calling Users#getFavorites without an id requires authentication");
+        }
+        const res = await this.main.request.get(`/favorites.json${!id ? "" : `?user_id=${id}`}`);
+        return res.posts.map(info => new Post_1.default(this.main, info));
+    }
+    /**
+     * Add a favorite
+     *
+     * * Requires Authentication
+     *
+     * @param {number} id - the id of the post to favorite
+     * @returns {Promise<Post>}
+     */
+    async addFavorite(id) {
+        this.main.request.authCheck.call(this, "Users#addFavorite");
+        const res = await this.main.request.get(`/favorites.json?post_id=${id}`);
+        return new Post_1.default(this.main, res.post);
+    }
+    /**
+     * Remove a favorite
+     *
+     * * Requires Authentication
+     *
+     * @param {number} id - the id of the post to unfavorite
+     * @returns {Promise<null>}
+     */
+    async removeFavorite(id) {
+        this.main.request.authCheck.call(this, "Users#removeFavorite");
+        return this.main.request.delete(`/favorites/${id}.json`);
+    }
+}
+exports.default = Users;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"Users.js","sourceRoot":"","sources":["../../../src/modules/Users.ts"],"names":[],"mappings":";;;;;AACA,wFAAgE;AAChE,8DAAsC;AACtC,8DAAsC;AAYtC,oEAA4C;AAC5C,2DAAkD;AAElD,MAAqB,KAAK;IACR,IAAI,CAAgB;IACpB,IAAI,CAAO;IAC5B,YAAY,IAAU;QACrB,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE;YAC7B,IAAI,EAAE;gBACL,GAAG;oBACF,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACnL,CAAC;gBACD,YAAY,EAAE,KAAK;gBACnB,UAAU,EAAE,KAAK;aACjB;YACD,IAAI,EAAE;gBACL,KAAK,EAAE,IAAI;gBACX,YAAY,EAAE,KAAK;gBACnB,UAAU,EAAE,KAAK;gBACjB,QAAQ,EAAE,KAAK;aACf;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,CAAC,QAAyB;QAClC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAiB,UAAU,QAAQ,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YAC9F,IAAI,GAAG,YAAY,yBAAQ,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG;gBAAE,OAAO,IAAI,CAAC;YACnE,MAAM,GAAG,CAAC;QACX,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,MAAM,CAAC,OAA4B;QACxC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,MAAM,EAAE,GAAG,IAAI,oBAAU,EAAE,CAAC;QAC5B,IAAI,OAAO,OAAO,CAAC,IAAI,KAAoB,QAAQ;YAAM,EAAE,CAAC,GAAG,CAAC,sBAAsB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QACtG,IAAI,OAAO,OAAO,CAAC,KAAK,KAAmB,QAAQ;YAAM,EAAE,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACxG,IAAI,OAAO,OAAO,CAAC,KAAK,KAAmB,QAAQ;YAAM,EAAE,CAAC,GAAG,CAAC,eAAe,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAChG,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAgB,QAAQ;YAAM,EAAE,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QACvG,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAgB,QAAQ;YAAM,EAAE,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QACvG,IAAI,OAAO,OAAO,CAAC,mBAAmB,KAAK,SAAS;YAAK,EAAE,CAAC,GAAG,CAAC,yBAAyB,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;QACxH,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAgB,SAAS;YAAK,EAAE,CAAC,GAAG,CAAC,2BAA2B,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC/G,IAAI,OAAO,OAAO,CAAC,KAAK,KAAmB,QAAQ;YAAM,EAAE,CAAC,GAAG,CAAC,eAAe,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAChG,IAAI,OAAO,OAAO,CAAC,IAAI,KAAoB,WAAW;YAAG,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QACtF,IAAI,OAAO,OAAO,CAAC,KAAK,KAAmB,QAAQ;YAAM,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACxF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAwB,wBAAwB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACrG,OAAO,GAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO;QACZ,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QACxD,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC3C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAA8B,UAAU,EAAE,OAAO,CAAC,CAAC;QAC1F,OAAO,IAAI,2BAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,GAAI,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CAAC,OAA4B;QAC1C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QACzD,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QACxE,MAAM,EAAE,GAAG,IAAI,oBAAU,EAAE,CAAC;QAC5B,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ;YAAE,EAAE,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC;QACzH,IAAI,OAAO,OAAO,CAAC,KAAK,KAAyB,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QACzG,IAAI,OAAO,OAAO,CAAC,OAAO,KAAuB,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7G,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAsB,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QACxG,IAAI,OAAO,OAAO,CAAC,yBAAyB,KAAK,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,mCAAmC,EAAE,OAAO,CAAC,yBAAyB,CAAC,CAAC;QAC3I,IAAI,OAAO,OAAO,CAAC,gBAAgB,KAAc,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,yBAAyB,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACxH,IAAI,OAAO,OAAO,CAAC,gBAAgB,KAAc,QAAQ,IAAI,OAAO,CAAC,gBAAgB,IAAI,EAAE,IAAI,OAAO,CAAC,gBAAgB,IAAI,GAAG;YAAE,EAAE,CAAC,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC7L,IAAI,OAAO,OAAO,CAAC,YAAY,KAAkB,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;QAC3G,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAsB,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC/G,IAAI,OAAO,OAAO,CAAC,eAAe,KAAe,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;YAAE,EAAE,CAAC,GAAG,CAAC,wBAAwB,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAC7O,IAAI,OAAO,OAAO,CAAC,cAAc,KAAgB,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;QACpH,WAAW;QACX,IAAI,OAAO,OAAO,CAAC,gBAAgB,KAAc,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACtH,IAAI,OAAO,OAAO,CAAC,uBAAuB,KAAO,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,kCAAkC,EAAE,OAAO,CAAC,uBAAuB,CAAC,CAAC;QACxI,IAAI,OAAO,OAAO,CAAC,kBAAkB,KAAY,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,4BAA4B,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAC7H,IAAI,OAAO,OAAO,CAAC,iBAAiB,KAAa,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,2BAA2B,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;QAC3H,IAAI,OAAO,OAAO,CAAC,oBAAoB,KAAU,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,4BAA4B,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC/H,IAAI,OAAO,OAAO,CAAC,oBAAoB,KAAU,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,uCAAuC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC1I,IAAI,OAAO,OAAO,CAAC,YAAY,KAAkB,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;QAChH,IAAI,OAAO,OAAO,CAAC,wBAAwB,KAAM,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,kCAAkC,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;QACzI,IAAI,OAAO,OAAO,CAAC,qBAAqB,KAAS,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,4BAA4B,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAChI,IAAI,OAAO,OAAO,CAAC,qBAAqB,KAAS,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,+BAA+B,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACnI,IAAI,OAAO,OAAO,CAAC,WAAW,KAAmB,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,sCAAsC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QAChI,IAAI,OAAO,OAAO,CAAC,YAAY,KAAkB,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;QAChH,IAAI,OAAO,OAAO,CAAC,qBAAqB,KAAS,SAAS;YAAE,EAAE,CAAC,GAAG,CAAC,+BAA+B,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACnI,IAAI,OAAO,OAAO,CAAC,cAAc,KAAgB,QAAQ;YAAG,EAAE,CAAC,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;QACjH,iFAAiF;QACjF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAO,eAAe,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC;QAC7E,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,cAAc;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAC;QAC/D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAc,0BAA0B,CAAC,CAAC;QACjF,OAAO,GAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,EAAW;QAC7B,IAAI,CAAC,EAAE,EAAE;YACR,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,oBAAoB,EAAE,KAAK,CAAC,CAAC;YACjF,IAAI,CAAC,IAAI;gBAAE,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;SAC/F;QACD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAoC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,EAAE,EAAE,EAAE,CAAC,CAAC;QAC5H,OAAO,GAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,WAAW,CAAC,EAAU;QAC3B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;QAC5D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAA4B,2BAA2B,EAAE,EAAE,CAAC,CAAC;QACpG,OAAO,IAAI,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAI,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAAC,EAAU;QAC9B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAC;QAC/D,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAO,cAAc,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;CACD;AA7MD,wBA6MC"}

package/build/src/modules/WikiPages.d.ts

@@ -0,0 +1,99 @@
+import type E621 from "..";
+import WikiPage from "../structures/WikiPage";
+import type { SearchWikiPagesOptions, CreateWikiPageOptions, ModifyWikiPageOptions, SearchWikiPageHistoryOptions } from "../types";
+import WikiPageHistory from "../structures/WikiPageHistory";
+export default class WikiPages {
+    private readonly auth;
+    private readonly main;
+    constructor(main: E621);
+    /**
+     * Get a wiki page by its id
+     *
+     * @param {number} id - The id of the wiki page to get
+     * @returns {Promise<(WikiPage | null)>}
+     */
+    get(id: number): Promise<WikiPage | null>;
+    /**
+     * Get a wiki page by its title
+     *
+     * @param {string} title - The title of the wiki page to get
+     * @returns {Promise<(WikiPage | null)>}
+     */
+    getByTitle(title: string): Promise<WikiPage | null>;
+    /**
+     * Search for wiki pages
+     *
+     * @param {object} [options]
+     * @param {string} [options.title] - narrow the results by the title of the wiki page
+     * @param {string} [options.creator] - narrow the results by the (name of the) creator of the wiki page
+     * @param {string} [options.body] - narrow the results by the content of the wiki page
+     * @param {string} [options.otherNames] - narrow the results by the other names of the wiki page
+     * @param {boolean} [options.hasOtherNames] - narrow the results by the wiki page having other names
+     * @param {boolean} [options.hideDeleted] - narrow the results by the wiki page being deleted or not
+     * @param {WikiPageOrder} [options.order] - the order of the results
+     * @param {(number |`${"" | "a" | "b"}${number}`)} [options.page] - page of results to get
+     * @param {number} [options.limit] - limit the maximum amount of results returned
+     * @returns {Promise<Array<WikiPage>>}
+     */
+    search(options?: SearchWikiPagesOptions): Promise<WikiPage[]>;
+    /**
+     * Create a wiki page
+     *
+     * * Requires Authentication
+     *
+     * @param {object} options
+     * @param {string} options.title - the name of the wiki page
+     * @param {string} options.body - the content of the wiki page
+     * @param {boolean} [options.locked] - if the wiki page should be locked (requires janitor)
+     * @param {boolean} [options.forceOverwrite] - if existing pages should be overwritten (requires janitor)
+     * @param {string} [options.reason] - the reson for creating the page
+     * @returns {Promise<WikiPage>}
+     */
+    create(options: CreateWikiPageOptions): Promise<WikiPage>;
+    /**
+     * modify a wiki page
+     *
+     * * Requires Authentication
+     *
+     * @param {number} id - the id of the wiki page to edit
+     * @param {object} options
+     * @param {string} [options.name] - the name of the wiki page (requires janitor)
+     * @param {string} [options.body] - the content of the wiki page
+     * @param {boolean} [options.locked] - if the wiki page is locked (requires janitor)
+     * @param {boolean} [options.forceOverwrite] - if existing pages should be overwritten (title change, requires janitor)
+     * @param {string} [options.reason] - the reason for the edit
+     * @returns {Promise<WikiPage>}
+     */
+    modify(id: number, options: ModifyWikiPageOptions): Promise<WikiPage>;
+    /**
+     * Delete a wiki page
+     *
+     * * Requires Authentication
+     *
+     * * Requires Janitor
+     *
+     * @param {number} id - the id of the wiki page to delete
+     * @returns {Promise<null>}
+     */
+    delete(id: number): Promise<null>;
+    /**
+     * Revert a wiki page to a previous version
+     *
+     * * Requires Authentication
+     *
+     * @param {number} id - the id of the wiki page to revert
+     * @param {number} versionID - the version id to revert to (see history)
+     */
+    revert(id: number, versionID: number): Promise<null>;
+    /**
+     * Search the wiki page history
+     *
+     * @param {object} [options]
+     * @param {number} [options.wikiPage] - narrow the results by the wiki page id
+     * @param {(number |`${"" | "a" | "b"}${number}`)} [options.page] - page of results to get
+     * @param {number} [options.limit] - limit the maximum amount of results returned
+     * @param
+     * @returns {Promise<Array<WikiPageHistory>>}
+     */
+    searchHistory(options?: SearchWikiPageHistoryOptions): Promise<WikiPageHistory[]>;
+}