e621 3.1.0 → 3.2.1

package/dist/lib/models/posts/Actions.d.ts

@@ -5,7 +5,7 @@ import type { PostVotesCreateData } from "../../generated/types.js";
 import type { FavoritesCreateResponse, FavoritesDestroyResponse } from "../../modules/Favorites.js";
 import type { DisapprovePostOptions } from "../../modules/PostDisapprovals.js";
 import type { FlagPostOptions } from "../../modules/PostFlags.js";
-import type { NoV2Options, PostFormat } from "../../modules/posts/Format.js";
+import type { NoV2Options, PostFormat, PostFormatOptions } from "../../modules/posts/Format.js";
 import type { DeletePostOptions, GetPostInSequenceOptions, ListPostFavoritesOptions, MarkPostAsTranslatedOptions, MovePostFavoritesOptions, PostPreviousOwner, RecommendedPostsOptions, RecommendedPostsResult, ReownPostOptions, UpdatePostIqdbOptions, UpdatePostOptions } from "../../modules/Posts.js";
 import type MinimalUser from "../MinimalUser.js";
 import type Post from "../Post.js";
@@ -14,292 +14,266 @@ import type PostFlag from "../PostFlag.js";
 /** @category Models */
 export default abstract class PostActions<T extends {
     id: number;
-}> extends Base<T> {
+}, PF extends PostFormatOptions = NoV2Options> extends Base<T, PF> {
     id: number;
     /**
-     * AI Check Post
      *
      * You must be Janitor+.
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#ai_check staff/post/posts#ai_check}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts\#ai_check staff/post/posts#ai_check}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#ai_check Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts\#ai_check Documentation} for more details.
      */
     aiCheck(): Promise<string>;
     /**
-     * Approve Post
      *
      * You must have the "Approve Posts" permission.
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/approvals#create staff/post/approvals#create}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/approvals\#create staff/post/approvals#create}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-staff/post/approvals#create Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/approvals\#create Documentation} for more details.
      */
     approve(): Promise<null>;
     /**
-     * Copy Notes To Post
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-posts#copy_notes posts#copy_notes}
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts\#copy_notes posts#copy_notes}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-posts#copy_notes Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-posts\#copy_notes Documentation} for more details.
      */
     copyNotes(other_post_id: number): Promise<null>;
     /**
-     * Create Post Vote
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Post_Votes-post_votes#create post_votes#create}
+     * @operationId {@link https://e621.wiki/#operations-Post_Votes-post_votes\#create post_votes#create}
      *
-     * @see {@link https://e621.wiki/#operations-Post_Votes-post_votes#create Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Post_Votes-post_votes\#create Documentation} for more details.
      */
     createVote(score: ExtractValue<"score", PostVotesCreateData>, no_unvote?: boolean): Promise<PostVotesCreateResponse>;
     /**
-     * Delete Post
      *
      * You must have the "Approve Posts" permission. `commit=Delete` must be set.
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#delete staff/post/posts#delete}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts\#delete staff/post/posts#delete}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#delete Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts\#delete Documentation} for more details.
      */
     delete(options: DeletePostOptions): Promise<unknown>;
     /**
-     * Create Post Disapproval
      *
      * You must have the "Approve Posts" permission.
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Post_Disapprovals-staff/post/disapprovals#create staff/post/disapprovals#create}
+     * @operationId {@link https://e621.wiki/#operations-Post_Disapprovals-staff/post/disapprovals\#create staff/post/disapprovals#create}
      *
-     * @see {@link https://e621.wiki/#operations-Post_Disapprovals-staff/post/disapprovals#create Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Post_Disapprovals-staff/post/disapprovals\#create Documentation} for more details.
      */
     disapprove(options: DisapprovePostOptions): Promise<PostDisapproval>;
     /**
-     * Expunge Post
      *
      * You must have the "Approve Posts" permission and be Admin+.
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#expunge staff/post/posts#expunge}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts\#expunge staff/post/posts#expunge}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#expunge Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts\#expunge Documentation} for more details.
      */
-    expunge(reason: string): Promise<Post>;
+    expunge(reason: string): Promise<Post<PF>>;
     /**
-     * Create Favorite
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Favorites-favorites#create favorites#create}
+     * @operationId {@link https://e621.wiki/#operations-Favorites-favorites\#create favorites#create}
      *
-     * @see {@link https://e621.wiki/#operations-Favorites-favorites#create Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Favorites-favorites\#create Documentation} for more details.
      */
     favorite(): Promise<FavoritesCreateResponse>;
     /**
-     * Post Favorites Index
      *
      * You must be the user or Moderator+ to see users that have their favorites hidden.
      *
-     * @operationId {@link https://e621.wiki/#operations-Post_Favorites-post_favorites#index post_favorites#index}
+     * @operationId {@link https://e621.wiki/#operations-Post_Favorites-post_favorites\#index post_favorites#index}
      *
-     * @see {@link https://e621.wiki/#operations-Post_Favorites-post_favorites#index Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Post_Favorites-post_favorites\#index Documentation} for more details.
      */
     favorites(options: ListPostFavoritesOptions): Promise<Array<MinimalUser>>;
     /**
-     * Create Post Flag
      *
      * Will error if post_id is not provided.
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Post_Flags-post_flags#create post_flags#create}
+     * @operationId {@link https://e621.wiki/#operations-Post_Flags-post_flags\#create post_flags#create}
      *
-     * @see {@link https://e621.wiki/#operations-Post_Flags-post_flags#create Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Post_Flags-post_flags\#create Documentation} for more details.
      */
     flag(options: FlagPostOptions): Promise<PostFlag>;
     /**
-     * Mark Post As Translated
      *
      * Will error if no body is provided.
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-posts#mark_as_translated posts#mark_as_translated}
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts\#mark_as_translated posts#mark_as_translated}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-posts#mark_as_translated Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-posts\#mark_as_translated Documentation} for more details.
      */
-    markTranslated<const O extends MarkPostAsTranslatedOptions = NoV2Options>(options?: O): Promise<PostFormat<O["v2"], O["mode"]>>;
+    markTranslated<const O extends MarkPostAsTranslatedOptions = PF>(options?: O): Promise<PostFormat<O["v2"], O["mode"], PF>>;
     /**
-     * Move Post Favorites
      *
      * You must have the "Approve Posts" permission. `commit=Submit`` must be set.
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#move_favorites staff/post/posts#move_favorites}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts\#move_favorites staff/post/posts#move_favorites}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#move_favorites Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts\#move_favorites Documentation} for more details.
      */
     moveFavorites(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}
+     * @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.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts\#previous_owners Documentation} for more details.
      */
     previousOwners(): Promise<Array<PostPreviousOwner>>;
     /**
-     * Get Recommended Posts For Artist
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-post_recommendations#artist post_recommendations#artist}
+     * @operationId {@link https://e621.wiki/#operations-Posts-post_recommendations\#artist post_recommendations#artist}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-post_recommendations#artist Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-post_recommendations\#artist Documentation} for more details.
      */
-    recommendedByArtist(options?: RecommendedPostsOptions): Promise<RecommendedPostsResult>;
+    recommendedByArtist(options?: RecommendedPostsOptions): Promise<RecommendedPostsResult<PF>>;
     /**
-     * Get Recommended Posts For Tags
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-post_recommendations#tags post_recommendations#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.
+     * @see {@link https://e621.wiki/#operations-Posts-post_recommendations\#tags Documentation} for more details.
      */
-    recommendedByTags(options?: RecommendedPostsOptions): Promise<RecommendedPostsResult>;
+    recommendedByTags(options?: RecommendedPostsOptions): Promise<RecommendedPostsResult<PF>>;
     /**
-     * Regenerate Post Thumbnails
      *
      * You must be Janitor+.
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#regenerate_thumbnails staff/post/posts#regenerate_thumbnails}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts\#regenerate_thumbnails staff/post/posts#regenerate_thumbnails}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#regenerate_thumbnails Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts\#regenerate_thumbnails Documentation} for more details.
      */
-    regenerateThumbnails(): Promise<Post>;
+    regenerateThumbnails(): Promise<Post<PF>>;
     /**
-     * Regenerate Post Videos
      *
      * You must be Janitor+.
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#regenerate_videos staff/post/posts#regenerate_videos}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts\#regenerate_videos staff/post/posts#regenerate_videos}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#regenerate_videos Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts\#regenerate_videos Documentation} for more details.
      */
     regenerateVideos(): 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}
+     * @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.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts\#reowner Documentation} for more details.
      */
     reown(options: ReownPostOptions): Promise<string>;
     /**
-     * Revert Post
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-posts#revert posts#revert}
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts\#revert posts#revert}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-posts#revert Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-posts\#revert Documentation} for more details.
      */
     revert(version_id: number): Promise<null>;
     /**
-     * Get Post In Sequence
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-posts#show_seq posts#show_seq}
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts\#show_seq posts#show_seq}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-posts#show_seq Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-posts\#show_seq Documentation} for more details.
      */
-    sequence<const O extends GetPostInSequenceOptions = NoV2Options>(options?: O): Promise<PostFormat<O["v2"], O["mode"]>>;
+    sequence<const O extends GetPostInSequenceOptions = PF>(options?: O): Promise<PostFormat<O["v2"], O["mode"], PF>>;
     /**
-     * Unapprove Post
      *
      * You must have the "Approve Posts" permission. The response does not differ for success or failure.
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/approvals#destroy staff/post/approvals#destroy}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/approvals\#destroy staff/post/approvals#destroy}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-staff/post/approvals#destroy Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/approvals\#destroy Documentation} for more details.
      */
     unapprove(): Promise<null>;
     /**
-     * Undelete Post
      *
      * You must have the "Approve Posts" permission.
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts#undelete staff/post/posts#undelete}
+     * @operationId {@link https://e621.wiki/#operations-Posts-staff/post/posts\#undelete staff/post/posts#undelete}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts#undelete Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-staff/post/posts\#undelete Documentation} for more details.
      */
-    undelete(): Promise<Post>;
+    undelete(): Promise<Post<PF>>;
     /**
-     * Delete Favorite
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Favorites-favorites#destroy favorites#destroy}
+     * @operationId {@link https://e621.wiki/#operations-Favorites-favorites\#destroy favorites#destroy}
      *
-     * @see {@link https://e621.wiki/#operations-Favorites-favorites#destroy Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Favorites-favorites\#destroy Documentation} for more details.
      */
     unfavorite(): Promise<FavoritesDestroyResponse>;
     /**
-     * Delete Post Vote
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Post_Votes-post_votes#destroy post_votes#destroy}
+     * @operationId {@link https://e621.wiki/#operations-Post_Votes-post_votes\#destroy post_votes#destroy}
      *
-     * @see {@link https://e621.wiki/#operations-Post_Votes-post_votes#destroy Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Post_Votes-post_votes\#destroy Documentation} for more details.
      */
     unvote(): Promise<null>;
     /**
-     * Update Post
      *
      * Most errors are silently swallowed.
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-posts#update posts#update}
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts\#update posts#update}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-posts#update Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-posts\#update Documentation} for more details.
      */
-    update<const O extends UpdatePostOptions = NoV2Options>(options?: O): Promise<PostFormat<O["v2"], O["mode"]>>;
+    update<const O extends UpdatePostOptions = PF>(options?: O): Promise<PostFormat<O["v2"], O["mode"], PF>>;
     /**
-     * Update Post IQDB
      *
      * You must be Admin+.
      *
      * @requiresApiKeyAuth
      *
-     * @operationId {@link https://e621.wiki/#operations-Posts-posts#update_iqdb posts#update_iqdb}
+     * @operationId {@link https://e621.wiki/#operations-Posts-posts\#update_iqdb posts#update_iqdb}
      *
-     * @see {@link https://e621.wiki/#operations-Posts-posts#update_iqdb Documentation} for more details.
+     * @see {@link https://e621.wiki/#operations-Posts-posts\#update_iqdb Documentation} for more details.
      */
-    updateIqdb<const O extends UpdatePostIqdbOptions = NoV2Options>(options?: O): Promise<PostFormat<O["v2"], O["mode"]>>;
+    updateIqdb<const O extends UpdatePostIqdbOptions = PF>(options?: O): Promise<PostFormat<O["v2"], O["mode"], PF>>;
 }