Class StaffNotes

Hierarchy (View Summary)

Base
- StaffNotes

Index

Constructors

Methods

create delete get search undelete update

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:20

Methods

create

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

Operation Id
staff_notes#create

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

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
staff_notes#delete

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

get

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

Operation Id
staff_notes#show

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

search

search(options?: SearchStaffNotesOptions): Promise<StaffNote[]>
Staff Notes Index
Parameters
- Optionaloptions: SearchStaffNotesOptions
Returns Promise<StaffNote[]>

Operation Id
staff_notes#index

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

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
staff_notes#undelete

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

update

update(id: number, options: UpdateStaffNoteOptions): Promise<StaffNote>
Requires Api Key Auth
Update Staff Note

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

Operation Id
staff_notes#update

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