Class UploadWhitelists

Hierarchy (View Summary)

Base
- UploadWhitelists

Index

Constructors

Methods

check create delete search update

Constructors

constructor

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

Methods

check

check(url: string): Promise<UploadWhitelistsIsAllowedResponse>
Requires Api Key Auth
Check If URL Is Allowed
Parameters
- url: string
Returns Promise<UploadWhitelistsIsAllowedResponse>

Operation Id
upload_whitelists#is_allowed

See
Documentation for more details.
- Defined in lib/modules/UploadWhitelists.ts:42

create

create(options: CreateUploadWhitelistOptions): Promise<UploadWhitelist>
Requires Api Key Auth
Create Upload Whitelist

You must be Admin+.
Parameters
- options: CreateUploadWhitelistOptions
Returns Promise<UploadWhitelist>

Operation Id
upload_whitelists#create

See
Documentation for more details.
- Defined in lib/modules/UploadWhitelists.ts:61

delete

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

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

Operation Id
upload_whitelists#destroy

See
Documentation for more details.
- Defined in lib/modules/UploadWhitelists.ts:80

search

search(options?: SearchUploadWhitelistsOptions): Promise<UploadWhitelist[]>
Upload Whitelists Index
Parameters
- Optionaloptions: SearchUploadWhitelistsOptions
Returns Promise<UploadWhitelist[]>

Operation Id
upload_whitelists#index

See
Documentation for more details.
- Defined in lib/modules/UploadWhitelists.ts:95

update

update(id: number, options: UpdateUploadWhitelistOptions): Promise<null>
Requires Api Key Auth
Update Upload Whitelist
Parameters
- id: number
- options: UpdateUploadWhitelistOptions
Returns Promise<null>

Operation Id
upload_whitelists#update

See
Documentation for more details.
- Defined in lib/modules/UploadWhitelists.ts:112