Class PostSet

Schema

See

Documentation for more details.

Hierarchy (View Summary)

PostSet
Base<PostSetData>
- PostSet

Index

Constructors

Methods

[custom] addPosts delete removePosts toJSON update updatePosts

Constructors

constructor

new PostSet(e621: E621, data: PostSet): PostSet
Parameters
- e621: E621
- data: PostSet
Returns PostSet
Inherited from Base.constructor
- Defined in lib/models/Base.ts:10

Methods

[custom]

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

addPosts

addPosts(post_ids: number[]): Promise<PostSet>
Requires Api Key Auth
Add Posts To Post Set

You must be the owner of the set, a maintainer (if public), or Admin+.
Parameters
- post_ids: number[]
Returns Promise<PostSet>

Operation Id
post_sets#add_posts

See
Documentation for more details.
- Defined in lib/models/PostSet.ts:30

delete

delete(): Promise<null>
Requires Api Key Auth
Delete Post Set

You must be the owner of the set, or Admin+.

Returns Promise<null>

Operation Id
post_sets#destroy

See
Documentation for more details.
- Defined in lib/models/PostSet.ts:46

removePosts

removePosts(post_ids: number[]): Promise<PostSet>
Requires Api Key Auth
Remove Posts From Post Set

You must be the owner of the set, a maintainer (if public), or Admin+.
Parameters
- post_ids: number[]
Returns Promise<PostSet>

Operation Id
post_sets#remove_posts

See
Documentation for more details.
- Defined in lib/models/PostSet.ts:62

toJSON

toJSON(): PostSet
Returns PostSet
Inherited from Base.toJSON
- Defined in lib/models/Base.ts:40

update

update(options: UpdatePostSetOptions): Promise<null>
Requires Api Key Auth
Update Post Set

You must be the owner of the set, or Admin+.
Parameters
- options: UpdatePostSetOptions
Returns Promise<null>

Operation Id
post_sets#update

See
Documentation for more details.
- Defined in lib/models/PostSet.ts:78

updatePosts

updatePosts(post_ids: number[]): Promise<PostSet>
Requires Api Key Auth
Update Post Set Posts

You must be the owner of the set, a maintainer (if public), or Admin+.
Parameters
- post_ids: number[]
Returns Promise<PostSet>

Operation Id
post_sets#update_posts

See
Documentation for more details.
- Defined in lib/models/PostSet.ts:94