Class PostActions<T, PF>Abstract

constructor

• new PostActions<
      T extends { id: number },
      PF extends PostFormatOptions = NoV2Options,
  >(
      e621: E621<PF>,
      data: T,
  ): PostActions<T, PF>

  Type Parameters

  • T extends { id: number }
  • PF extends PostFormatOptions = NoV2Options

  Parameters

  • e621: E621<PF>
  • data: T

  Returns PostActions<T, PF>

id

aiCheck

• aiCheck(): Promise<string>
  Requires Api Key Auth

  You must be Janitor+.

  Returns Promise<string>

  Operation Id

  staff/post/posts#ai_check

  See

  Documentation for more details.

approve

• approve(): Promise<null>
  Requires Api Key Auth

  You must have the "Approve Posts" permission.

  Returns Promise<null>

  Operation Id

  staff/post/approvals#create

  See

  Documentation for more details.

copyNotes

• copyNotes(other_post_id: number): Promise<null>
  Requires Api Key Auth

  Parameters

  • other_post_id: number

  Returns Promise<null>

  Operation Id

  posts#copy_notes

  See

  Documentation for more details.

createVote

• createVote(
      score: UpDownVote,
      no_unvote?: boolean,
  ): Promise<PostVotesCreateResponse>
  Requires Api Key Auth

  Parameters

  • score: UpDownVote
  • Optionalno_unvote: boolean

  Returns Promise<PostVotesCreateResponse>

  Operation Id

  post_votes#create

  See

  Documentation for more details.

delete

• delete(options: DeletePostOptions): Promise<unknown>
  Requires Api Key Auth

  You must have the "Approve Posts" permission. commit=Delete must be set.

  Parameters

  • options: DeletePostOptions

  Returns Promise<unknown>

  Operation Id

  staff/post/posts#delete

  See

  Documentation for more details.

disapprove

• disapprove(options: DisapprovePostOptions): Promise<PostDisapproval>
  Requires Api Key Auth

  You must have the "Approve Posts" permission.

  Parameters

  • options: DisapprovePostOptions

  Returns Promise<PostDisapproval>

  Operation Id

  staff/post/disapprovals#create

  See

  Documentation for more details.

expunge

• expunge(reason: string): Promise<Post<PF>>
  Requires Api Key Auth

  You must have the "Approve Posts" permission and be Admin+.

  Parameters

  • reason: string

  Returns Promise<Post<PF>>

  Operation Id

  staff/post/posts#expunge

  See

  Documentation for more details.

favorite

• favorite(): Promise<FavoritesCreateResponse>
  Requires Api Key Auth

  Returns Promise<FavoritesCreateResponse>

  Operation Id

  favorites#create

  See

  Documentation for more details.

favorites

• favorites(options: ListPostFavoritesOptions): Promise<MinimalUser[]>

  You must be the user or Moderator+ to see users that have their favorites hidden.

  Parameters

  • options: ListPostFavoritesOptions

  Returns Promise<MinimalUser[]>

  Operation Id

  post_favorites#index

  See

  Documentation for more details.

flag

• flag(options: FlagPostOptions): Promise<PostFlag>
  Requires Api Key Auth

  Will error if post_id is not provided.

  Parameters

  • options: FlagPostOptions

  Returns Promise<PostFlag>

  Operation Id

  post_flags#create

  See

  Documentation for more details.

markTranslated

• markTranslated<const O extends MarkPostAsTranslatedOptions = PF>(
      options?: O,
  ): Promise<PostFormat<O["v2"], O["mode"], PF>>
  Requires Api Key Auth

  Will error if no body is provided.

  Type Parameters

  • const O extends MarkPostAsTranslatedOptions = PF

  Parameters

  • Optionaloptions: O

  Returns Promise<PostFormat<O["v2"], O["mode"], PF>>

  Operation Id

  posts#mark_as_translated

  See

  Documentation for more details.

moveFavorites

• moveFavorites(options: MovePostFavoritesOptions): Promise<unknown>
  Requires Api Key Auth

  You must have the "Approve Posts" permission. `commit=Submit`` must be set.

  Parameters

  • options: MovePostFavoritesOptions

  Returns Promise<unknown>

  Operation Id

  staff/post/posts#move_favorites

  See

  Documentation for more details.

previousOwners

• previousOwners(): Promise<PostPreviousOwner[]>
  Requires Api Key Auth

  You must be an Approver

  Returns Promise<PostPreviousOwner[]>

  Operation Id

  staff/post/posts#previous_owners

  See

  Documentation for more details.

recommendedByArtist

• recommendedByArtist(
      options?: RecommendedPostsOptions,
  ): Promise<RecommendedPostsResult<PF>>

  Parameters

  • Optionaloptions: RecommendedPostsOptions

  Returns Promise<RecommendedPostsResult<PF>>

  Operation Id

  post_recommendations#artist

  See

  Documentation for more details.

recommendedByTags

• recommendedByTags(
      options?: RecommendedPostsOptions,
  ): Promise<RecommendedPostsResult<PF>>

  Parameters

  • Optionaloptions: RecommendedPostsOptions

  Returns Promise<RecommendedPostsResult<PF>>

  Operation Id

  post_recommendations#tags

  See

  Documentation for more details.

regenerateThumbnails

• regenerateThumbnails(): Promise<Post<PF>>
  Requires Api Key Auth

  You must be Janitor+.

  Returns Promise<Post<PF>>

  Operation Id

  staff/post/posts#regenerate_thumbnails

  See

  Documentation for more details.

regenerateVideos

• regenerateVideos(): Promise<null>
  Requires Api Key Auth

  You must be Janitor+.

  Returns Promise<null>

  Operation Id

  staff/post/posts#regenerate_videos

  See

  Documentation for more details.

reown

• reown(options: ReownPostOptions): Promise<string>
  Requires Api Key Auth

  You must have be Janitor+ and an Approver

  Parameters

  • options: ReownPostOptions

  Returns Promise<string>

  Operation Id

  staff/post/posts#reowner

  See

  Documentation for more details.

revert

• revert(version_id: number): Promise<null>
  Requires Api Key Auth

  Parameters

  • version_id: number

  Returns Promise<null>

  Operation Id

  posts#revert

  See

  Documentation for more details.

sequence

• sequence<const O extends GetPostInSequenceOptions = PF>(
      options?: O,
  ): Promise<PostFormat<O["v2"], O["mode"], PF>>

  Type Parameters

  • const O extends GetPostInSequenceOptions = PF

  Parameters

  • Optionaloptions: O

  Returns Promise<PostFormat<O["v2"], O["mode"], PF>>

  Operation Id

  posts#show_seq

  See

  Documentation for more details.

unapprove

• unapprove(): Promise<null>
  Requires Api Key Auth

  You must have the "Approve Posts" permission. The response does not differ for success or failure.

  Returns Promise<null>

  Operation Id

  staff/post/approvals#destroy

  See

  Documentation for more details.

undelete

• undelete(): Promise<Post<PF>>
  Requires Api Key Auth

  You must have the "Approve Posts" permission.

  Returns Promise<Post<PF>>

  Operation Id

  staff/post/posts#undelete

  See

  Documentation for more details.

unfavorite

• unfavorite(): Promise<FavoritesDestroyResponse>
  Requires Api Key Auth

  Returns Promise<FavoritesDestroyResponse>

  Operation Id

  favorites#destroy

  See

  Documentation for more details.

unvote

• unvote(): Promise<null>
  Requires Api Key Auth

  Returns Promise<null>

  Operation Id

  post_votes#destroy

  See

  Documentation for more details.

update

• update<const O extends UpdatePostOptions = PF>(
      options?: O,
  ): Promise<PostFormat<O["v2"], O["mode"], PF>>
  Requires Api Key Auth

  Most errors are silently swallowed.

  Type Parameters

  • const O extends UpdatePostOptions = PF

  Parameters

  • Optionaloptions: O

  Returns Promise<PostFormat<O["v2"], O["mode"], PF>>

  Operation Id

  posts#update

  See

  Documentation for more details.

updateIqdb

• updateIqdb<const O extends UpdatePostIqdbOptions = PF>(
      options?: O,
  ): Promise<PostFormat<O["v2"], O["mode"], PF>>
  Requires Api Key Auth

  You must be Admin+.

  Type Parameters

  • const O extends UpdatePostIqdbOptions = PF

  Parameters

  • Optionaloptions: O

  Returns Promise<PostFormat<O["v2"], O["mode"], PF>>

  Operation Id

  posts#update_iqdb

  See

  Documentation for more details.