e621 3.0.3 → 3.1.0

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

@@ -1,28 +1,64 @@
+import MinimalUser from "../models/MinimalUser.js";
 import Post from "../models/Post.js";
-import { type ExtractValue, type TransformDataBodyToOptions, type TransformDataQueryToOptions } from "../util.js";
+import ThumbnailPost from "../models/ThumbnailPost.js";
+import { type TransformDataBodyToOptions, type TransformDataQueryToOptions } from "../util.js";
 import Base from "./Base.js";
-import PostFlag from "./posts/Flag.js";
-import PostVotes from "./posts/Votes.js";
-import type { DeletePostData, GetPostInSequenceData, GetRecommendedPostsData, ListPostFavoritesData, MovePostFavoritesData, RecommendedPosts, SearchPostsData } from "../generated/types.js";
+import { type NoV2Options, type PostFormat } from "./posts/Format.js";
+import type { StaffPostPostsDeleteData, PostsShowData, PostsShowSeqData, PostsRandomData, PostRecommendationsArtistData, PostFavoritesIndexData, PostsMarkAsTranslatedData, StaffPostPostsMoveFavoritesData, PostRecommendation, StaffPostPostsReownerData, PostsIndexData, PostsUpdateData, PostsUpdateIqdbData } from "../generated/types.js";
 /** @category Modules/Types */
-export interface DeletePostOptions extends TransformDataBodyToOptions<DeletePostData> {
+export interface DeletePostOptions extends TransformDataBodyToOptions<StaffPostPostsDeleteData> {
 }
 /** @category Modules/Types */
-export interface MovePostFavoritesOptions extends TransformDataBodyToOptions<MovePostFavoritesData> {
+export interface MovePostFavoritesOptions extends TransformDataBodyToOptions<StaffPostPostsMoveFavoritesData> {
 }
 /** @category Modules/Types */
-export interface SearchPostsOptions extends TransformDataQueryToOptions<SearchPostsData> {
+export interface SearchPostsOptions extends TransformDataQueryToOptions<PostsIndexData> {
 }
 /** @category Modules/Types */
-export interface ListPostFavoritesOptions extends TransformDataQueryToOptions<ListPostFavoritesData> {
+export interface ListPostFavoritesOptions extends TransformDataQueryToOptions<PostFavoritesIndexData> {
 }
 /** @category Modules/Types */
-export interface GetRecommendedPostsOptions extends TransformDataQueryToOptions<GetRecommendedPostsData> {
+export interface GetRandomPostOptions extends TransformDataQueryToOptions<PostsRandomData> {
 }
+/** @category Modules/Types */
+export interface GetPostOptions extends TransformDataQueryToOptions<PostsShowData> {
+}
+/** @category Modules/Types */
+export interface GetPostInSequenceOptions extends TransformDataQueryToOptions<PostsShowSeqData> {
+}
+/** @category Modules/Types */
+export interface MarkPostAsTranslatedOptions extends TransformDataQueryToOptions<PostsMarkAsTranslatedData> {
+}
+/** @category Modules/Types */
+export interface UpdatePostOptions extends TransformDataBodyToOptions<PostsUpdateData>, TransformDataQueryToOptions<PostsUpdateData> {
+}
+/** @category Modules/Types */
+export interface UpdatePostIqdbOptions extends TransformDataQueryToOptions<PostsUpdateIqdbData> {
+}
+/** @category Modules/Types */
+export interface RecommendedPostsOptions extends TransformDataQueryToOptions<PostRecommendationsArtistData> {
+}
+/** @category Modules/Types */
+export interface ReownPostOptions extends TransformDataBodyToOptions<StaffPostPostsReownerData> {
+}
+/** @category Modules/Types */
+export interface PostPreviousOwner {
+    id: number;
+    name: string;
+}
+/** @category Modules/Types */
+export interface RecommendedPostsResult {
+    model_version: string;
+    post_data: Array<ThumbnailPost>;
+    post_id: number;
+    results: Array<PostRecommendation>;
+}
+/** @category Modules/Types */
+export type PostSearchResult<O extends SearchPostsOptions> = O extends {
+    md5: string;
+} ? PostFormat<O["v2"], O["mode"]> : Array<PostFormat<O["v2"], O["mode"]>>;
 /** @category Modules */
 export default class Posts extends Base {
-    flag: PostFlag;
-    votes: PostVotes;
     /**
      * AI Check Post
      *
@@ -30,9 +66,9 @@ export default class Posts extends Base {
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-aiCheckPost aiCheckPost}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#ai_check staff/post/posts#ai_check}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-aiCheckPost Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#ai_check Documentation} for more details.
      */
     aiCheck(id: number): Promise<string>;
     /**
@@ -40,9 +76,9 @@ export default class Posts extends Base {
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-copyNotesToPost copyNotesToPost}
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts#copy_notes posts#copy_notes}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-copyNotesToPost Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-posts#copy_notes Documentation} for more details.
      */
     copyNotes(id: number, other_post_id: number): Promise<null>;
     /**
@@ -52,9 +88,9 @@ export default class Posts extends Base {
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-deletePost deletePost}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#delete staff/post/posts#delete}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-deletePost Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#delete Documentation} for more details.
      */
     delete(id: number, options: DeletePostOptions): Promise<unknown>;
     /**
@@ -64,29 +100,29 @@ export default class Posts extends Base {
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-expungePost expungePost}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#expunge staff/post/posts#expunge}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-expungePost Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#expunge Documentation} for more details.
      */
     expunge(id: number, reason: string): Promise<Post>;
     /**
-     * List Post Favorites
+     * Post Favorites Index
      *
      * You must be the user or Moderator+ to see users that have their favorites hidden.
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-listPostFavorites listPostFavorites}
+     * @operationId {@link https://e621.wiki/#operations-Post_Favorites-post_favorites#index post_favorites#index}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-listPostFavorites Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Post_Favorites-post_favorites#index Documentation} for more details.
      */
-    favorites(id: number, options: ListPostFavoritesOptions): Promise<Array<Post>>;
+    favorites(id: number, options: ListPostFavoritesOptions): Promise<Array<MinimalUser>>;
     /**
      * Get Post
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-getPost getPost}
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts#show posts#show}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-getPost Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-posts#show Documentation} for more details.
      */
-    get(id: number): Promise<Post | null>;
+    get<const O extends GetPostOptions = NoV2Options>(id: number, options?: O): Promise<PostFormat<O["v2"], O["mode"]> | null>;
     /**
      * Mark Post As Translated
      *
@@ -94,11 +130,11 @@ export default class Posts extends Base {
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-markPostAsTranslated markPostAsTranslated}
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts#mark_as_translated posts#mark_as_translated}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-markPostAsTranslated Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-posts#mark_as_translated Documentation} for more details.
      */
-    markTranslated(id: number): Promise<Post>;
+    markTranslated<const O extends MarkPostAsTranslatedOptions = NoV2Options>(id: number, options?: O): Promise<PostFormat<O["v2"], O["mode"]>>;
     /**
      * Move Post Favorites
      *
@@ -106,27 +142,47 @@ export default class Posts extends Base {
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-movePostFavorites movePostFavorites}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#move_favorites staff/post/posts#move_favorites}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-movePostFavorites Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#move_favorites Documentation} for more details.
      */
     moveFavorites(id: number, options: MovePostFavoritesOptions): Promise<unknown>;
+    /**
+     * Get Post Previous Owners
+     *
+     * You must be an Approver
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#previous_owners staff/post/posts#previous_owners}
+     *
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#previous_owners Documentation} for more details.
+     */
+    previousOwners(id: number): Promise<Array<PostPreviousOwner>>;
     /**
      * Get Random Post
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-getRandomPost getRandomPost}
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts#random posts#random}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-getRandomPost Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-posts#random Documentation} for more details.
      */
-    random(tags?: string): Promise<Post>;
+    random<const O extends GetRandomPostOptions = NoV2Options>(options?: O): Promise<PostFormat<O["v2"], O["mode"]>>;
     /**
-     * Get Recommended Posts
+     * Get Recommended Posts For Artist
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-getRecommendedPosts getRecommendedPosts}
+     * @operationId {@link https://e621.wiki/#operations-Posts-post_recommendations#artist post_recommendations#artist}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-getRecommendedPosts Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-post_recommendations#artist Documentation} for more details.
      */
-    recommended(id: number, options: GetRecommendedPostsOptions): Promise<RecommendedPosts>;
+    recommendedByArtist(id: number, options?: RecommendedPostsOptions): Promise<RecommendedPostsResult>;
+    /**
+     * Get Recommended Posts For Tags
+     *
+     * @operationId {@link https://e621.wiki/#operations-Posts-post_recommendations#tags post_recommendations#tags}
+     *
+     * @see {@link https://e621.wiki/#operations-Posts-post_recommendations#tags Documentation} for more details.
+     */
+    recommendedByTags(id: number, options?: RecommendedPostsOptions): Promise<RecommendedPostsResult>;
     /**
      * Regenerate Post Thumbnails
      *
@@ -134,9 +190,9 @@ export default class Posts extends Base {
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-regeneratePostThumbnails regeneratePostThumbnails}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#regenerate_thumbnails staff/post/posts#regenerate_thumbnails}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-regeneratePostThumbnails Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#regenerate_thumbnails Documentation} for more details.
      */
     regenerateThumbnails(id: number): Promise<Post>;
     /**
@@ -146,37 +202,49 @@ export default class Posts extends Base {
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-regeneratePostVideos regeneratePostVideos}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#regenerate_videos staff/post/posts#regenerate_videos}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-regeneratePostVideos Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#regenerate_videos Documentation} for more details.
      */
     regenerateVideos(id: number): Promise<null>;
+    /**
+     * Reown Post
+     *
+     * You must have be Janitor+ and an Approver
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#reowner staff/post/posts#reowner}
+     *
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#reowner Documentation} for more details.
+     */
+    reown(id: number, options: ReownPostOptions): Promise<string>;
     /**
      * Revert Post
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-revertPost revertPost}
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts#revert posts#revert}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-revertPost Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-posts#revert Documentation} for more details.
      */
     revert(id: number, version_id: number): Promise<null>;
     /**
-     * Search Posts
+     * Posts Index
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-searchPosts searchPosts}
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts#index posts#index}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-searchPosts Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-posts#index Documentation} for more details.
      */
-    search(options?: SearchPostsOptions): Promise<Array<Post>>;
+    search<const O extends SearchPostsOptions = NoV2Options>(options?: O): Promise<PostSearchResult<O>>;
     /**
      * Get Post In Sequence
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-getPostInSequence getPostInSequence}
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts#show_seq posts#show_seq}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-getPostInSequence Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-posts#show_seq Documentation} for more details.
      */
-    sequence(id: number, seq?: ExtractValue<"seq", GetPostInSequenceData>): Promise<Post>;
+    sequence<const O extends GetPostInSequenceOptions = NoV2Options>(id: number, options?: O): Promise<PostFormat<O["v2"], O["mode"]>>;
     /**
      * Undelete Post
      *
@@ -184,11 +252,23 @@ export default class Posts extends Base {
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-undeletePost undeletePost}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#undelete staff/post/posts#undelete}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-undeletePost Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#undelete Documentation} for more details.
      */
     undelete(id: number): Promise<Post>;
+    /**
+     * Update Post
+     *
+     * Most errors are silently swallowed.
+     *
+     * @requiresApiKeyAuth
+     *
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts#update posts#update}
+     *
+     * @see {@link https://e621.wiki/#operations-Posts-posts#update Documentation} for more details.
+     */
+    update<const O extends UpdatePostOptions = NoV2Options>(id: number, options?: O): Promise<PostFormat<O["v2"], O["mode"]>>;
     /**
      * Update Post IQDB
      *
@@ -196,9 +276,9 @@ export default class Posts extends Base {
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-updatePostIqdb updatePostIqdb}
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts#update_iqdb posts#update_iqdb}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-updatePostIqdb Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-posts#update_iqdb Documentation} for more details.
      */
-    updateIqdb(id: number): Promise<Post>;
+    updateIqdb<const O extends UpdatePostIqdbOptions = NoV2Options>(id: number, options?: O): Promise<PostFormat<O["v2"], O["mode"]>>;
 }