Class Posts<PF>

constructor

• new Posts<PF extends PostFormatOptions = NoV2Options>(
      e621: E621<PF> | undefined,
      client: Client,
      defaultFormat?: PF,
  ): Posts<PF>

  Type Parameters

  • PF extends PostFormatOptions = NoV2Options

  Parameters

  • e621: E621<PF> | undefined
  • client: Client
  • defaultFormat: PF = ...

    The v2/mode format to fall back to for any method here (or any convenience method on a returned post model) called without explicit v2/mode options. Defaults to the legacy format, matching new E621()'s behavior when Options.defaultPostFormat isn't set.

  Returns Posts<PF>

Static ReadonlymoduleKey

aiCheck

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

  You must be Janitor+.

  Parameters

  • id: number

  Returns Promise<string>

  Operation Id

  staff/post/posts#ai_check

  See

  Documentation for more details.

copyNotes

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

  Parameters

  • id: number
  • other_post_id: number

  Returns Promise<null>

  Operation Id

  posts#copy_notes

  See

  Documentation for more details.

count

• count(tags: string): Promise<PostsCountResponse>

  Parameters

  • tags: string

  Returns Promise<PostsCountResponse>

  Operation Id

  posts#count

  See

  Documentation for more details.

delete

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

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

  Parameters

  • id: number
  • options: DeletePostOptions

  Returns Promise<unknown>

  Operation Id

  staff/post/posts#delete

  See

  Documentation for more details.

expunge

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

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

  Parameters

  • id: number
  • reason: string

  Returns Promise<Post<PF>>

  Operation Id

  staff/post/posts#expunge

  See

  Documentation for more details.

favorites

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

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

  Parameters

  • id: number
  • options: ListPostFavoritesOptions

  Returns Promise<MinimalUser[]>

  Operation Id

  post_favorites#index

  See

  Documentation for more details.

get

• get<const O extends GetPostOptions = PF>(
      id: number,
      options?: O,
  ): Promise<PostFormat<O["v2"], O["mode"], PF> | null>

  Type Parameters

  • const O extends GetPostOptions = PF

  Parameters

  • id: number
  • Optionaloptions: O

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

  Operation Id

  posts#show

  See

  Documentation for more details.

markTranslated

• markTranslated<const O extends MarkPostAsTranslatedOptions = PF>(
      id: number,
      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

  • id: number
  • Optionaloptions: O

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

  Operation Id

  posts#mark_as_translated

  See

  Documentation for more details.

moveFavorites

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

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

  Parameters

  • id: number
  • options: MovePostFavoritesOptions

  Returns Promise<unknown>

  Operation Id

  staff/post/posts#move_favorites

  See

  Documentation for more details.

previousOwners

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

  You must be an Approver

  Parameters

  • id: number

  Returns Promise<PostPreviousOwner[]>

  Operation Id

  staff/post/posts#previous_owners

  See

  Documentation for more details.

random

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

  Type Parameters

  • const O extends GetRandomPostOptions = PF

  Parameters

  • Optionaloptions: O

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

  Operation Id

  posts#random

  See

  Documentation for more details.

recommendedByArtist

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

  Parameters

  • id: number
  • Optionaloptions: RecommendedPostsOptions

  Returns Promise<RecommendedPostsResult<PF>>

  Operation Id

  post_recommendations#artist

  See

  Documentation for more details.

recommendedByTags

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

  Parameters

  • id: number
  • Optionaloptions: RecommendedPostsOptions

  Returns Promise<RecommendedPostsResult<PF>>

  Operation Id

  post_recommendations#tags

  See

  Documentation for more details.

regenerateThumbnails

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

  You must be Janitor+.

  Parameters

  • id: number

  Returns Promise<Post<PF>>

  Operation Id

  staff/post/posts#regenerate_thumbnails

  See

  Documentation for more details.

regenerateVideos

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

  You must be Janitor+.

  Parameters

  • id: number

  Returns Promise<null>

  Operation Id

  staff/post/posts#regenerate_videos

  See

  Documentation for more details.

reown

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

  You must have be Janitor+ and an Approver

  Parameters

  • id: number
  • options: ReownPostOptions

  Returns Promise<string>

  Operation Id

  staff/post/posts#reowner

  See

  Documentation for more details.

revert

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

  Parameters

  • id: number
  • version_id: number

  Returns Promise<null>

  Operation Id

  posts#revert

  See

  Documentation for more details.

search

• search<const O extends SearchPostsOptions = PF>(
      options?: O,
  ): Promise<PostSearchResult<O, PF>>

  Type Parameters

  • const O extends SearchPostsOptions = PF

  Parameters

  • Optionaloptions: O

  Returns Promise<PostSearchResult<O, PF>>

  Operation Id

  posts#index

  See

  Documentation for more details.

sequence

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

  Type Parameters

  • const O extends GetPostInSequenceOptions = PF

  Parameters

  • id: number
  • Optionaloptions: O

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

  Operation Id

  posts#show_seq

  See

  Documentation for more details.

undelete

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

  You must have the "Approve Posts" permission.

  Parameters

  • id: number

  Returns Promise<Post<PF>>

  Operation Id

  staff/post/posts#undelete

  See

  Documentation for more details.

update

• update<const O extends UpdatePostOptions = PF>(
      id: number,
      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

  • id: number
  • 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>(
      id: number,
      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

  • id: number
  • Optionaloptions: O

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

  Operation Id

  posts#update_iqdb

  See

  Documentation for more details.