Class Mascots

Hierarchy (View Summary)

Base
- Mascots

Index

Constructors

Methods

create delete search update

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

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
mascots#create

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

delete

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

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

Operation Id
mascots#destroy

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

search

search(options?: SearchMascotsOptions): Promise<Mascot[]>
Mascots Index
Parameters
- Optionaloptions: SearchMascotsOptions
Returns Promise<Mascot[]>

Operation Id
mascots#index

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

update

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

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

Operation Id
mascots#update

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