Class Appeals

constructor

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

  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 Appeals

Static ReadonlymoduleKey

claim

• claim(id: number): Promise<Appeal>
  Requires Api Key Auth

  You must be Janitor+

  Parameters

  • id: number

  Returns Promise<Appeal>

  Operation Id

  appeals#claim

  See

  Documentation for more details.

get

• get(id: number): Promise<Appeal | null>
  Requires Api Key Auth

  Requires Janitor+ to see appeals not created by you.

  Parameters

  • id: number

  Returns Promise<Appeal | null>

  Operation Id

  appeals#show

  See

  Documentation for more details.

search

• search(options?: SearchAppealsOptions): Promise<Appeal[]>
  Requires Cookie Auth

  Requires Janitor+ to see appeals not created by you.

  Parameters

  • Optionaloptions: SearchAppealsOptions

  Returns Promise<Appeal[]>

  Operation Id

  appeals#index

  See

  Documentation for more details.

unclaim

• unclaim(id: number): Promise<Appeal>
  Requires Api Key Auth

  You must be Janitor+

  Parameters

  • id: number

  Returns Promise<Appeal>

  Operation Id

  appeals#unclaim

  See

  Documentation for more details.

update

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

  You must be Janitor+.

  Parameters

  • id: number
  • options: UpdateAppealOptions

  Returns Promise<null>

  Operation Id

  appeals#update

  See

  Documentation for more details.