import { API, Miscellaneous, User } from "../index.js";
export interface Forum {
    id: number;
    name: string;
    description: string;
}
export declare namespace Forum {
    /** This is a forum with subforums, but those subforums do NOT have subforums */
    interface WithSubforums extends Forum {
        subforums: Forum[];
    }
    /** This is a forum with subforums, those subforums also have subforums, which in turn do not have subforums */
    interface WithSubforums2 extends Forum {
        subforums: Forum.WithSubforums[];
    }
    /**
     * @obtainableFrom
     * {@link API.replyForumTopic} /
     * {@link API.createForumTopic} /
     * {@link API.getForumTopic} /
     * {@link API.editForumPost}
     */
    interface Post {
        created_at: Date;
        deleted_at: Date | null;
        edited_at: Date | null;
        edited_by_id: number | null;
        forum_id: Forum["id"];
        id: number;
        topic_id: Topic["id"];
        user_id: User["id"];
        body: Miscellaneous.RichText;
    }
    namespace Post {
        /**
         * Edit a ForumPost! Note that it can be the initial one of a ForumTopic!
         * @scope {@link Scope"forum.write"}
         * @param post The post or the id of the post in question
         * @param new_text The new content of the post (replaces the old content)
         * @returns The edited ForumPost
         */
        function edit(this: API, post: Post["id"] | Post, new_text: string): Promise<Post>;
    }
    /**
     * @obtainableFrom
     * {@link API.createForumTopic} /
     * {@link API.getForumTopic} /
     * {@link API.editForumTopicTitle}
     */
    interface Topic {
        created_at: Date;
        deleted_at: Date | null;
        first_post_id: Post["id"];
        forum_id: Forum["id"];
        id: number;
        is_locked: boolean;
        last_post_id: Post["id"];
        post_count: number;
        title: string;
        type: "normal" | "sticky" | "announcement";
        updated_at: Date;
        user_id: User["id"];
        poll: {
            allow_vote_change: boolean;
            /** @remarks Can be in the future */
            ended_at: Date | null;
            hide_incomplete_results: boolean;
            last_vote_at: Date | null;
            max_votes: number;
            options: {
                id: number;
                text: {
                    bbcode: string;
                    html: string;
                };
                /** @remarks Not present if the poll is incomplete and results are hidden */
                vote_count?: number;
            }[];
            started_at: Date;
            title: {
                bbcode: string;
                html: string;
            };
            total_vote_count: number;
        } | null;
    }
    namespace Topic {
        /**
         * Get a Forum.Topic, as well as its main post (content) and the posts that were sent in it!
         * @param topic An object with the id of the topic in question
         * @param config How many results maximum, how to sort them, etc...
         * @remarks The oldest post of a topic is the text of a topic
         */
        function getOne(this: API, topic: Topic["id"] | Topic, config?: Pick<Miscellaneous.Config, "limit" | "sort" | "cursor_string"> & {
            /** The id (or the post itself) of the first post to be returned in `posts` (irrelevant if using a `cursor_string`) */
            first_post?: Post["id"] | Post;
        }): Promise<{
            topic: Topic;
            posts: Post[];
            cursor_string: Miscellaneous.CursorString | null;
        }>;
        /**
         * Get multiple existing Forum.Topic, optionally in a specific Forum!
         * @param config Specify the Forum of the Topics, sorting options, how many Topics maximum...
         * @returns An object with an array of relevant Forum.Topic, and a `cursor_string` to allow you to go further
         */
        function getMultiple(this: API, config?: Pick<Miscellaneous.Config, "limit" | "sort" | "cursor_string"> & {
            /** From which specific Forum to get the topcis from */
            forum?: Forum["id"] | Forum;
        }): Promise<{
            topics: Forum.Topic[];
            cursor_string: Miscellaneous.CursorString | null;
        }>;
        /**
         * Create a new Forum.Topic in the forum of your choice!
         * @scope {@link Scope"forum.write"}
         * @param forum The Forum you're creating your topic in
         * @param title The topic's title
         * @param text The first post's content/message
         * @param poll If you want to make a poll, specify the parameters of that poll!
         * @returns An object with the topic you've made, and its first initial post (which uses your `text`)
         * @remarks Some users may not be allowed to do that, such as newly registered users, so this can 403 even with the right scopes
         */
        function create(this: API, forum: Forum["id"] | Forum, title: string, text: string, poll?: {
            title: string;
            /** The things the users can vote for */
            options: string[];
            /** Length of voting period in days, 0 means forever */
            length_days: number;
            /** The maximum amount of votes per user! (defaults to **1**) */
            max_options?: number;
            /** Do you allow users to change their vote? (defaults to **false**) */
            vote_change?: boolean;
            /** Should the results of the poll be hidden while the voting period is still active? (defaults to **false**) */
            hide_results?: boolean;
        }): Promise<{
            topic: Forum.Topic;
            post: Forum.Post;
        }>;
        /**
         * Make and send a Forum.Post in a Forum.Topic!
         * @scope {@link Scope"forum.write"}
         * @param topic The topic or the id of the topic you're making your reply in
         * @param text Your reply! Your message!
         * @returns The reply you've made, as a Forum.Post!
         * @remarks Replying when the last post was made by the authorized user will likely cause the server to return a 403
         */
        function reply(this: API, topic: Topic["id"] | Topic, text: string): Promise<Post>;
        /**
         * Edit the title of a Forum.Topic!
         * @scope {@link Scope"forum.write"}
         * @param topic The topic or the id of the topic in question
         * @param new_title The new title of the topic
         * @returns The edited ForumTopic
         * @remarks Use `editForumPost` if you wanna edit the post at the top of the topic
         */
        function editTitle(this: API, topic: Topic["id"] | Topic, new_title: string): Promise<Topic>;
        /**
         * Lock or unlock a Forum.Topic that you're allowed to moderate!
         * @scope {@link Scope"forum.write_manage"}
         * @param topic The topic or the id of the topic in question
         * @param lock True if locking, false if unlocking (defaults to **true**)
         */
        function lock(this: API, topic: Topic["id"] | Topic, lock?: boolean): Promise<void>;
        /**
         * Pin or unpin a Forum.Topic that you're allowed to moderate!
         * @scope {@link Scope"forum.write_manage"}
         * @param topic The topic or the id of the topic in question
         * @param pin_type The exact action, as in what kind of pin if you're not unpinning
         */
        function pin(this: API, topic: Topic["id"] | Topic, pin_type: "unpin" | "sticky" | "announcement"): Promise<void>;
    }
    /**
     * Get a Forum with a specific id, as well as its Forum.Topics!
     * @param forum The Forum you want to get
     * @returns An object with the Forum, its topics, and the topics pinned in it
     */
    function getOne(this: API, forum: Forum["id"] | Forum): Promise<{
        forum: Forum.WithSubforums2;
        topics: Forum.Topic[];
        pinned_topics: Forum.Topic[];
    }>;
    /**
     * Get a list of all top-level Forums!
     * @returns All the top-level forums
     * @remarks The subforums of a forum are in the properties of their respective forum
     */
    function getMultiple(this: API): Promise<Forum.WithSubforums2[]>;
}