Class Mascots

Hierarchy (View Summary)

Base
- Mascots

Index

Constructors

Methods

create delete edit search

Constructors

constructor

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

Methods

create

create(options: CreateMascotOptions): Promise<Mascot>
Requires Api Key Auth
Create Mascot

You must be Admin+.
Parameters
- options: CreateMascotOptions
Returns Promise<Mascot>
Operation Id
createMascot

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

delete

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

You must be Admin+.
Parameters
- id: number
Returns Promise<null>
Operation Id
deleteMascot

See
Documentation for more details.
- Defined in lib/modules/Mascots.ts:47

edit

edit(id: number, options: EditMascotOptions): Promise<null>
Requires Api Key Auth
Edit Mascot

You must be Admin+.
Parameters
- id: number
- options: EditMascotOptions
Returns Promise<null>
Operation Id
editMascot

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

search

search(options?: SearchMascotsOptions): Promise<Mascot[]>
Search Mascots
Parameters
- Optionaloptions: SearchMascotsOptions
Returns Promise<Mascot[]>
Operation Id
searchMascots

See
Documentation for more details.
- Defined in lib/modules/Mascots.ts:82