Class StaffNotes

Hierarchy (View Summary)

Base
- StaffNotes

Index

Constructors

Methods

create delete edit get search undelete

Constructors

constructor

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

Methods

create

create(options: CreateStaffNoteOptions): Promise<StaffNote>
Requires Api Key Auth
Create Staff Note
Parameters
- options: CreateStaffNoteOptions
Returns Promise<StaffNote>
Operation Id
createStaffNote

See
Documentation for more details.
- Defined in lib/modules/StaffNotes.ts:33

delete

delete(id: number): Promise<StaffNote>
Requires Api Key Auth
Delete Staff Note

You must be the creator or Admin+.
Parameters
- id: number
Returns Promise<StaffNote>
Operation Id
deleteStaffNote

See
Documentation for more details.
- Defined in lib/modules/StaffNotes.ts:53

edit

edit(id: number, options: EditStaffNoteOptions): Promise<StaffNote>
Requires Api Key Auth
Edit Staff Note

You must be the creator or Admin+.
Parameters
- id: number
- options: EditStaffNoteOptions
Returns Promise<StaffNote>
Operation Id
editStaffNote

See
Documentation for more details.
- Defined in lib/modules/StaffNotes.ts:72

get

get(id: number): Promise<StaffNote | null>
Get Staff Note
Parameters
- id: number
Returns Promise<StaffNote | null>
Operation Id
getStaffNote

See
Documentation for more details.
- Defined in lib/modules/StaffNotes.ts:88

search

search(options?: SearchStaffNotesOptions): Promise<StaffNote[]>
Search Staff Notes
Parameters
- Optionaloptions: SearchStaffNotesOptions
Returns Promise<StaffNote[]>
Operation Id
searchStaffNotes

See
Documentation for more details.
- Defined in lib/modules/StaffNotes.ts:103

undelete

undelete(id: number): Promise<StaffNote>
Requires Api Key Auth
Undelete Staff Note

You must be the creator or Admin+.
Parameters
- id: number
Returns Promise<StaffNote>
Operation Id
undeleteStaffNote

See
Documentation for more details.
- Defined in lib/modules/StaffNotes.ts:123