Class Appeals

Hierarchy (View Summary)

Base
- Appeals

Index

Constructors

Methods

claim get search unclaim update

Constructors

constructor

new Appeals(e621: E621, client: Client): Appeals
Parameters
- e621: E621
- client: Client
Returns Appeals
Inherited from Base.constructor
- Defined in lib/modules/Base.ts:20

Methods

claim

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

You must be Janitor+
Parameters
- id: number
Returns Promise<Appeal>

Operation Id
appeals#claim

See
Documentation for more details.
- Defined in lib/modules/Appeals.ts:28

get

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

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.
- Defined in lib/modules/Appeals.ts:47

search

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

Requires Janitor+ to see appeals not created by you.
Parameters
- Optionaloptions: SearchAppealsOptions
Returns Promise<Appeal[]>

Operation Id
appeals#index

See
Documentation for more details.
- Defined in lib/modules/Appeals.ts:66

unclaim

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

You must be Janitor+
Parameters
- id: number
Returns Promise<Appeal>

Operation Id
appeals#unclaim

See
Documentation for more details.
- Defined in lib/modules/Appeals.ts:89

update

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

You must be Janitor+.
Parameters
- id: number
- options: UpdateAppealOptions
Returns Promise<null>

Operation Id
appeals#update

See
Documentation for more details.
- Defined in lib/modules/Appeals.ts:108