Class TagAliases

Hierarchy (View Summary)

Base
- TagAliases

Index

Constructors

Methods

approve create get reject search update

Constructors

constructor

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

Methods

approve

approve(id: number): Promise<null>
Requires Api Key Auth
Approve Tag Alias

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

Operation Id
tag_aliases#approve

See
Documentation for more details.
- Defined in lib/modules/TagAliases.ts:36

create

create(options: CreateTagAliasOptions): Promise<unknown>
Requires Api Key Auth
Create Tag Alias

Errors will result in a 406 with no information.
Parameters
- options: CreateTagAliasOptions
Returns Promise<unknown>

Operation Id
tag_alias_requests#create

See
Documentation for more details.
- Defined in lib/modules/TagAliases.ts:55

get

get(id: number): Promise<TagAlias | null>
Get Tag Alias
Parameters
- id: number
Returns Promise<TagAlias | null>

Operation Id
tag_aliases#show

See
Documentation for more details.
- Defined in lib/modules/TagAliases.ts:70

reject

reject(id: number): Promise<null>
Requires Api Key Auth
Reject Tag Alias

You must be the creator of the request (if pending), or Admin+.
Parameters
- id: number
Returns Promise<null>

Operation Id
tag_aliases#destroy

See
Documentation for more details.
- Defined in lib/modules/TagAliases.ts:89

search

search(options?: SearchTagAliasesOptions): Promise<TagAlias[]>
Tag Aliases Index
Parameters
- Optionaloptions: SearchTagAliasesOptions
Returns Promise<TagAlias[]>

Operation Id
tag_aliases#index

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

update

update(id: number, options: UpdateTagAliasOptions): Promise<null>
Requires Api Key Auth
Update Tag Alias

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

Operation Id
tag_aliases#update

See
Documentation for more details.
- Defined in lib/modules/TagAliases.ts:123