Class PostSets

constructor

• new PostSets(e621: E621<NoV2Options> | undefined, client: Client): PostSets

  e621 may be omitted (pass undefined) when constructing a module standalone, without the main E621 client, to keep bundles tree-shakable. Convenience methods on models returned by this module that call back into other modules via this.e621 will throw in that case.

  Parameters

  • e621: E621<NoV2Options> | undefined
  • client: Client

  Returns PostSets

Static ReadonlymoduleKey

addPosts

• addPosts(id: number, post_ids: number[]): Promise<PostSet>
  Requires Api Key Auth

  You must be the owner of the set, a maintainer (if public), or Admin+.

  Parameters

  • id: number
  • post_ids: number[]

  Returns Promise<PostSet>

  Operation Id

  post_sets#add_posts

  See

  Documentation for more details.

create

• create(options: CreatePostSetOptions): Promise<PostSet>
  Requires Api Key Auth

  Parameters

  • options: CreatePostSetOptions

  Returns Promise<PostSet>

  Operation Id

  post_sets#create

  See

  Documentation for more details.

delete

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

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

  Parameters

  • id: number

  Returns Promise<null>

  Operation Id

  post_sets#destroy

  See

  Documentation for more details.

forSelect

• forSelect(): Promise<PostSetsForSelectResponse>
  Requires Api Key Auth

  You must be the owner of the set, a maintainer (if public), or Admin+.

  Returns Promise<PostSetsForSelectResponse>

  Operation Id

  post_sets#for_select

  See

  Documentation for more details.

get

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

  You must be Moderator+ if the set is not public.

  Parameters

  • id: number

  Returns Promise<PostSet | null>

  Operation Id

  post_sets#show

  See

  Documentation for more details.

removePosts

• removePosts(id: number, post_ids: number[]): Promise<PostSet>
  Requires Api Key Auth

  You must be the owner of the set, a maintainer (if public), or Admin+.

  Parameters

  • id: number
  • post_ids: number[]

  Returns Promise<PostSet>

  Operation Id

  post_sets#remove_posts

  See

  Documentation for more details.

search

• search(options?: SearchPostSetsOptions): Promise<PostSet[]>

  Parameters

  • Optionaloptions: SearchPostSetsOptions

  Returns Promise<PostSet[]>

  Operation Id

  post_sets#index

  See

  Documentation for more details.

update

• update(id: number, options: UpdatePostSetOptions): Promise<null>
  Requires Api Key Auth

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

  Parameters

  • id: number
  • options: UpdatePostSetOptions

  Returns Promise<null>

  Operation Id

  post_sets#update

  See

  Documentation for more details.

updatePosts

• updatePosts(id: number, post_ids: number[]): Promise<PostSet>
  Requires Api Key Auth

  You must be the owner of the set, a maintainer (if public), or Admin+.

  Parameters

  • id: number
  • post_ids: number[]

  Returns Promise<PostSet>

  Operation Id

  post_sets#update_posts

  See

  Documentation for more details.