Class AvoidPostings

Hierarchy (View Summary)

Base
- AvoidPostings

Index

Constructors

Methods

create delete destroy get search undelete update

Constructors

constructor

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

Methods

create

create(options: CreateAvoidPostingOptions): Promise<AvoidPosting>
Requires Api Key Auth
Create Avoid Posting

Must have the bd staff user flag.
Parameters
- options: CreateAvoidPostingOptions
Returns Promise<AvoidPosting>

Operation Id
avoid_postings#create

See
Documentation for more details.
- Defined in lib/modules/AvoidPostings.ts:38

delete

delete(idOrName: string | number): Promise<null>
Requires Api Key Auth
Delete Avoid Posting

Soft deletion. Must have the bd staff user flag.
Parameters
- idOrName: string | number
Returns Promise<null>

Operation Id
avoid_postings#delete

See
Documentation for more details.
- Defined in lib/modules/AvoidPostings.ts:57

destroy

destroy(idOrName: string | number): Promise<null>
Requires Api Key Auth
Destroy Avoid Posting

Must have the bd staff user flag.
Parameters
- idOrName: string | number
Returns Promise<null>

Operation Id
avoid_postings#destroy

See
Documentation for more details.
- Defined in lib/modules/AvoidPostings.ts:76

get

get(idOrName: string | number): Promise<AvoidPosting | null>
Get Avoid Posting
Parameters
- idOrName: string | number
Returns Promise<AvoidPosting | null>

Operation Id
avoid_postings#show

See
Documentation for more details.
- Defined in lib/modules/AvoidPostings.ts:91

search

search(options?: SearchAvoidPostingsOptions): Promise<AvoidPosting[]>
Avoid Posting Index
Parameters
- Optionaloptions: SearchAvoidPostingsOptions
Returns Promise<AvoidPosting[]>

Operation Id
avoid_postings#index

See
Documentation for more details.
- Defined in lib/modules/AvoidPostings.ts:106

undelete

undelete(idOrName: string | number): Promise<null>
Requires Api Key Auth
Undelete Avoid Posting

Must have the bd staff user flag.
Parameters
- idOrName: string | number
Returns Promise<null>

Operation Id
avoid_postings#undelete

See
Documentation for more details.
- Defined in lib/modules/AvoidPostings.ts:125

update

update(
idOrName: string | number,
options?: UpdateAvoidPostingOptions,
): Promise<null>
Requires Api Key Auth
Update Avoid Posting

Must have the bd staff user flag.
Parameters
- idOrName: string | number
- Optionaloptions: UpdateAvoidPostingOptions
Returns Promise<null>

Operation Id
avoid_postings#update

See
Documentation for more details.
- Defined in lib/modules/AvoidPostings.ts:144