Class NewsUpdates

Hierarchy (View Summary)

Base
- NewsUpdates

Index

Constructors

Methods

create delete search update

Constructors

constructor

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

Methods

create

create(options: CreateNewsUpdateOptions): Promise<NewsUpdate>
Requires Api Key Auth
Create News Update

You must be Admin+.
Parameters
- options: CreateNewsUpdateOptions
Returns Promise<NewsUpdate>

Operation Id
news_updates#create

See
Documentation for more details.
- Defined in lib/modules/NewsUpdates.ts:30

delete

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

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

Operation Id
news_updates#destroy

See
Documentation for more details.
- Defined in lib/modules/NewsUpdates.ts:49

search

search(options?: SearchNewsUpdatesOptions): Promise<NewsUpdate[]>
News Updates Index
Parameters
- Optionaloptions: SearchNewsUpdatesOptions
Returns Promise<NewsUpdate[]>

Operation Id
news_updates#index

See
Documentation for more details.
- Defined in lib/modules/NewsUpdates.ts:64

update

update(id: number, options: UpdateNewsUpdateOptions): Promise<null>
Requires Api Key Auth
Update News Update

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

Operation Id
news_updates#update

See
Documentation for more details.
- Defined in lib/modules/NewsUpdates.ts:83