Class EmailBlacklists

Hierarchy (View Summary)

Base
- EmailBlacklists

Index

Constructors

Methods

create delete search

Constructors

constructor

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

Methods

create

create(options: CreateEmailBlacklistOptions): Promise<EmailBlacklist>
Requires Api Key Auth
Create Email Blacklist

You must be Admin+.
Parameters
- options: CreateEmailBlacklistOptions
Returns Promise<EmailBlacklist>
Operation Id
createEmailBlacklist

See
Documentation for more details.
- Defined in lib/modules/EmailBlacklists.ts:26

delete

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

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

See
Documentation for more details.
- Defined in lib/modules/EmailBlacklists.ts:45

search

search(options?: SearchEmailBlacklistsOptions): Promise<EmailBlacklist[]>
Search Email Blacklists
Parameters
- Optionaloptions: SearchEmailBlacklistsOptions
Returns Promise<EmailBlacklist[]>
Operation Id
searchEmailBlacklists

See
Documentation for more details.
- Defined in lib/modules/EmailBlacklists.ts:60