Class IpBans

Hierarchy (View Summary)

Base
- IpBans

Index

Constructors

Methods

create delete search

Constructors

constructor

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

Methods

create

create(options: CreateIpBanOptions): Promise<IpBan>
Requires Api Key Auth
Create IP Ban

You must be Admin+.
Parameters
- options: CreateIpBanOptions
Returns Promise<IpBan>

Operation Id
ip_bans#create

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

delete

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

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

Operation Id
ip_bans#destroy

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

search

search(options?: SearchIpBansOptions): Promise<IpBan[]>
Requires Api Key Auth
IP Bans Index
Parameters
- Optionaloptions: SearchIpBansOptions
Returns Promise<IpBan[]>

Operation Id
ip_bans#index

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