Class BasicPost<PF>

Schema

BasicPost

See

Documentation for more details.

Type Parameters

PF extends PostFormatOptions = NoV2Options

Hierarchy (View Summary)

BasicPost
PostActions<PostData, PF>
- BasicPost

Index

Constructors

constructor

new BasicPost<PF extends PostFormatOptions = NoV2Options>(
e621: E621<PF>,
data: BasicPost,
): BasicPost<PF>
Type Parameters
- PF extends PostFormatOptions = NoV2Options
Parameters
- e621: E621<PF>
- data: BasicPost
Returns BasicPost<PF>
Inherited from PostActions.constructor
- Defined in lib/models/Base.ts:11

Properties

id

id: number

Methods

[custom]

"[custom]"(_depth: never, opts: InspectOptions): string
Parameters
- _depth: never
- opts: InspectOptions
Returns string
Inherited from PostActions.[custom]
- Defined in lib/models/Base.ts:19

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.
Inherited from PostActions.aiCheck
- Defined in lib/models/posts/Actions.ts:43

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.
Inherited from PostActions.approve
- Defined in lib/models/posts/Actions.ts:58

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.
Inherited from PostActions.copyNotes
- Defined in lib/models/posts/Actions.ts:71

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.
Inherited from PostActions.createVote
- Defined in lib/models/posts/Actions.ts:84

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.
Inherited from PostActions.delete
- Defined in lib/models/posts/Actions.ts:99

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.
Inherited from PostActions.disapprove
- Defined in lib/models/posts/Actions.ts:114

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.
Inherited from PostActions.expunge
- Defined in lib/models/posts/Actions.ts:129

favorite

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

Operation Id
favorites#create

See
Documentation for more details.
Inherited from PostActions.favorite
- Defined in lib/models/posts/Actions.ts:142

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.
Inherited from PostActions.favorites
- Defined in lib/models/posts/Actions.ts:155

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.
Inherited from PostActions.flag
- Defined in lib/models/posts/Actions.ts:170

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.
Inherited from PostActions.markTranslated
- Defined in lib/models/posts/Actions.ts:185

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.
Inherited from PostActions.moveFavorites
- Defined in lib/models/posts/Actions.ts:200

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.
Inherited from PostActions.previousOwners
- Defined in lib/models/posts/Actions.ts:215

recommendedByArtist

recommendedByArtist(
options?: RecommendedPostsOptions,
): Promise<RecommendedPostsResult<PF>>
Parameters
- Optionaloptions: RecommendedPostsOptions
Returns Promise<RecommendedPostsResult<PF>>

Operation Id
post_recommendations#artist

See
Documentation for more details.
Inherited from PostActions.recommendedByArtist
- Defined in lib/models/posts/Actions.ts:226

recommendedByTags

recommendedByTags(
options?: RecommendedPostsOptions,
): Promise<RecommendedPostsResult<PF>>
Parameters
- Optionaloptions: RecommendedPostsOptions
Returns Promise<RecommendedPostsResult<PF>>

Operation Id
post_recommendations#tags

See
Documentation for more details.
Inherited from PostActions.recommendedByTags
- Defined in lib/models/posts/Actions.ts:237

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.
Inherited from PostActions.regenerateThumbnails
- Defined in lib/models/posts/Actions.ts:252

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.
Inherited from PostActions.regenerateVideos
- Defined in lib/models/posts/Actions.ts:267

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.
Inherited from PostActions.reown
- Defined in lib/models/posts/Actions.ts:282

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.
Inherited from PostActions.revert
- Defined in lib/models/posts/Actions.ts:295

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.
Inherited from PostActions.sequence
- Defined in lib/models/posts/Actions.ts:306

toJSON

toJSON(): BasicPost
Returns BasicPost
Inherited from PostActions.toJSON
- Defined in lib/models/Base.ts:41

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.
Inherited from PostActions.unapprove
- Defined in lib/models/posts/Actions.ts:321

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.
Inherited from PostActions.undelete
- Defined in lib/models/posts/Actions.ts:336

unfavorite

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

Operation Id
favorites#destroy

See
Documentation for more details.
Inherited from PostActions.unfavorite
- Defined in lib/models/posts/Actions.ts:349

unvote

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

Operation Id
post_votes#destroy

See
Documentation for more details.
Inherited from PostActions.unvote
- Defined in lib/models/posts/Actions.ts:362

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.
Inherited from PostActions.update
- Defined in lib/models/posts/Actions.ts:377

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.
Inherited from PostActions.updateIqdb
- Defined in lib/models/posts/Actions.ts:392

Class BasicPost<PF>

Schema

See

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BasicPost<PF>

Properties

id

Methods

[custom]

Parameters

Returns string

aiCheck

Returns Promise<string>

Operation Id

See

approve

Returns Promise<null>

Operation Id

See

copyNotes

Parameters

Returns Promise<null>

Operation Id

See

createVote

Parameters

Returns Promise<PostVotesCreateResponse>

Operation Id

See

delete

Parameters

Returns Promise<unknown>

Operation Id

See

disapprove

Parameters

Returns Promise<PostDisapproval>

Operation Id

See

expunge

Parameters

Returns Promise<Post<PF>>

Operation Id

See

favorite

Returns Promise<FavoritesCreateResponse>

Operation Id

See

favorites

Parameters

Returns Promise<MinimalUser[]>

Operation Id

See

flag

Parameters

Returns Promise<PostFlag>

Operation Id

See

markTranslated

Type Parameters

Parameters

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

Operation Id

See

moveFavorites

Parameters

Returns Promise<unknown>

Operation Id

See

previousOwners

Returns Promise<PostPreviousOwner[]>