Class StaffWikis

Hierarchy (View Summary)

Base
- StaffWikis

Index

Constructors

Methods

claim create delete get search unclaim update

Constructors

constructor

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

Methods

claim

claim(id: number): Promise<StaffWiki>
Requires Api Key Auth
Claim Staff Wiki

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

Operation Id
staff/wikis#claim

See
Documentation for more details.
- Defined in lib/modules/staff/Wikis.ts:29

create

create(options: CreateStaffWikiOptions): Promise<StaffWiki>
Requires Api Key Auth
Create Staff Wiki

You must be Staff+
Parameters
- options: CreateStaffWikiOptions
Returns Promise<StaffWiki>

Operation Id
staff/wikis#create

See
Documentation for more details.
- Defined in lib/modules/staff/Wikis.ts:48

delete

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

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

Operation Id
staff/wikis#destroy

See
Documentation for more details.
- Defined in lib/modules/staff/Wikis.ts:67

get

get(id: number): Promise<StaffWiki>
Requires Api Key Auth
Get Staff Wiki

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

Operation Id
staff/wikis#show

See
Documentation for more details.
- Defined in lib/modules/staff/Wikis.ts:86

search

search(options?: SearchStaffWikisOptions): Promise<StaffWiki[]>
Requires Api Key Auth
Staff Wikis Index

You must be Staff+.
Parameters
- Optionaloptions: SearchStaffWikisOptions
Returns Promise<StaffWiki[]>

Operation Id
staff/wikis#index

See
Documentation for more details.
- Defined in lib/modules/staff/Wikis.ts:105

unclaim

unclaim(id: number): Promise<StaffWiki>
Requires Api Key Auth
Unclaim Staff Wiki

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

Operation Id
staff/wikis#unclaim

See
Documentation for more details.
- Defined in lib/modules/staff/Wikis.ts:124

update

update(id: number, options: UpdateStaffWikiOptions): Promise<null>
Requires Api Key Auth
Update Staff Wiki

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

Operation Id
staff/wikis#update

See
Documentation for more details.
- Defined in lib/modules/staff/Wikis.ts:143