Class Pools

Hierarchy (View Summary)

Base
- Pools

Index

Constructors

Methods

addPost create delete get getRecent removePost revert search update

Constructors

constructor

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

Methods

addPost

addPost(pool_id: number, post_id: number): Promise<Pool>
Requires Api Key Auth
Add Post To Pool
Parameters
- pool_id: number
- post_id: number
Returns Promise<Pool>

Operation Id
pool_elements#create

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:46

create

create(options: CreatePoolOptions): Promise<Pool>
Requires Api Key Auth
Create Pool
Parameters
- options: CreatePoolOptions
Returns Promise<Pool>

Operation Id
pools#create

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:63

delete

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

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

Operation Id
pools#destroy

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:82

get

get(id: number): Promise<Pool | null>
Get Pool
Parameters
- id: number
Returns Promise<Pool | null>

Operation Id
pools#show

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:97

getRecent

getRecent(): Promise<PoolElementsRecentResponse>
Requires Api Key Auth
Get Recent Pools

Returns Promise<PoolElementsRecentResponse>

Operation Id
pool_elements#recent

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:114

removePost

removePost(pool_id: number, post_id: number): Promise<null>
Requires Api Key Auth
Remove Post From Pool
Parameters
- pool_id: number
- post_id: number
Returns Promise<null>

Operation Id
pool_elements#destroy

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:130

revert

revert(id: number, version_id: number): Promise<null>
Requires Api Key Auth
Revert Pool
Parameters
- id: number
- version_id: number
Returns Promise<null>

Operation Id
pools#revert

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:147

search

search(options?: SearchPoolsOptions): Promise<Pool[]>
Pools Index
Parameters
- Optionaloptions: SearchPoolsOptions
Returns Promise<Pool[]>

Operation Id
pools#index

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:163

update

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

Operation Id
pools#update

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:180