Class Posts

constructor

• new Posts(e621: E621, client: Client): Posts

  Parameters

  • e621: E621
  • client: Client

  Returns Posts

flag

votes

aiCheck

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

  AI Check Post

  You must be Janitor+.

  Parameters

  • id: number

  Returns Promise<string>

  Operation Id

  aiCheckPost

  See

  Documentation for more details.

copyNotes

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

  Copy Notes To Post

  Parameters

  • id: number
  • other_post_id: number

  Returns Promise<null>

  Operation Id

  copyNotesToPost

  See

  Documentation for more details.

delete

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

  Delete Post

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

  Parameters

  • id: number
  • options: DeletePostOptions

  Returns Promise<unknown>

  Operation Id

  deletePost

  See

  Documentation for more details.

expunge

• expunge(id: number, reason: string): Promise<Post>
  Requires Api Key Auth

  Expunge Post

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

  Parameters

  • id: number
  • reason: string

  Returns Promise<Post>

  Operation Id

  expungePost

  See

  Documentation for more details.

favorites

• favorites(id: number, options: ListPostFavoritesOptions): Promise<Post[]>

  List Post Favorites

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

  Parameters

  • id: number
  • options: ListPostFavoritesOptions

  Returns Promise<Post[]>

  Operation Id

  listPostFavorites

  See

  Documentation for more details.

get

• get(id: number): Promise<Post | null>

  Get Post

  Parameters

  • id: number

  Returns Promise<Post | null>

  Operation Id

  getPost

  See

  Documentation for more details.

markTranslated

• markTranslated(id: number): Promise<Post>
  Requires Api Key Auth

  Mark Post As Translated

  Will error if no body is provided.

  Parameters

  • id: number

  Returns Promise<Post>

  Operation Id

  markPostAsTranslated

  See

  Documentation for more details.

moveFavorites

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

  Move Post Favorites

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

  Parameters

  • id: number
  • options: MovePostFavoritesOptions

  Returns Promise<unknown>

  Operation Id

  movePostFavorites

  See

  Documentation for more details.

random

• random(tags?: string): Promise<Post>

  Get Random Post

  Parameters

  • Optionaltags: string

  Returns Promise<Post>

  Operation Id

  getRandomPost

  See

  Documentation for more details.

regenerateThumbnails

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

  Regenerate Post Thumbnails

  You must be Janitor+.

  Parameters

  • id: number

  Returns Promise<Post>

  Operation Id

  regeneratePostThumbnails

  See

  Documentation for more details.

regenerateVideos

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

  Regenerate Post Videos

  You must be Janitor+.

  Parameters

  • id: number

  Returns Promise<null>

  Operation Id

  regeneratePostVideos

  See

  Documentation for more details.

revert

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

  Revert Post

  Parameters

  • id: number
  • version_id: number

  Returns Promise<null>

  Operation Id

  revertPost

  See

  Documentation for more details.

search

• search(options?: SearchPostsOptions): Promise<Post[]>

  Search Posts

  Parameters

  • Optionaloptions: SearchPostsOptions

  Returns Promise<Post[]>

  Operation Id

  searchPosts

  See

  Documentation for more details.

sequence

• sequence(id: number, seq?: "next" | "prev"): Promise<Post>

  Get Post In Sequence

  Parameters

  • id: number
  • Optionalseq: "next" | "prev"

  Returns Promise<Post>

  Operation Id

  getPostInSequence

  See

  Documentation for more details.

undelete

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

  Undelete Post

  You must have the "Approve Posts" permission.

  Parameters

  • id: number

  Returns Promise<Post>

  Operation Id

  undeletePost

  See

  Documentation for more details.

updateIqdb

• updateIqdb(id: number): Promise<Post>
  Requires Api Key Auth

  Update Post IQDB

  You must be Admin+.

  Parameters

  • id: number

  Returns Promise<Post>

  Operation Id

  updatePostIqdb

  See

  Documentation for more details.