Class BulkUpdateRequests

Hierarchy (View Summary)

Base
- BulkUpdateRequests

Index

Constructors

Methods

approve create edit get reject search

Constructors

constructor

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

Methods

approve

approve(id: number): Promise<null>
Approve Bulk Update Request

Must be Admin+.
Parameters
- id: number
Returns Promise<null>
Operation Id
approveBulkUpdateRequest

See
Documentation for more details.
- Defined in lib/modules/BulkUpdateRequests.ts:33

create

create(options: CreateBulkUpdateRequestOptions): Promise<BulkUpdateRequest>
Requires Api Key Auth
Create Bulk Update Request
Parameters
- options: CreateBulkUpdateRequestOptions
Returns Promise<BulkUpdateRequest>
Operation Id
createBulkUpdateRequest

See
Documentation for more details.
- Defined in lib/modules/BulkUpdateRequests.ts:50

edit

edit(id: number, options: EditBulkUpdateRequestOptions): Promise<null>
Requires Api Key Auth
Edit Bulk Update Request

You must be the creator of the BUR, or Admin+.
Parameters
- id: number
- options: EditBulkUpdateRequestOptions
Returns Promise<null>
Operation Id
editBulkUpdateRequest

See
Documentation for more details.
- Defined in lib/modules/BulkUpdateRequests.ts:69

get

get(id: number): Promise<BulkUpdateRequest | null>
Get Bulk Update Request
Parameters
- id: number
Returns Promise<BulkUpdateRequest | null>
Operation Id
getBulkUpdateRequest

See
Documentation for more details.
- Defined in lib/modules/BulkUpdateRequests.ts:85

reject

reject(id: number): Promise<null>
Requires Api Key Auth
Reject Bulk Update Request

You must be the creator of the BUR, or Admin+.
Parameters
- id: number
Returns Promise<null>
Operation Id
rejectBulkUpdateRequest

See
Documentation for more details.
- Defined in lib/modules/BulkUpdateRequests.ts:104

search

search(options?: SearchBulkUpdateRequestsOptions): Promise<BulkUpdateRequest[]>
Search Bulk Update Requests
Parameters
- Optionaloptions: SearchBulkUpdateRequestsOptions
Returns Promise<BulkUpdateRequest[]>
Operation Id
searchBulkUpdateRequests

See
Documentation for more details.
- Defined in lib/modules/BulkUpdateRequests.ts:119