Class JournalClient

Hierarchy

JournalClient

Index

Constructors

constructor

Properties

client

Methods

Constructors

constructor

new JournalClient(client: HttpClient): JournalClient

- Defined in admin-api/src/clients/JournalClient.ts:8
Parameters
- client: HttpClient
Returns JournalClient

Properties

Private client

client: HttpClient

Methods

create

create(params: JournalParam): Promise<Response<Journal>>

- Defined in admin-api/src/clients/JournalClient.ts:44
Creates a journal.

Parameters
- params: JournalParam
  
  parameter for creates
Returns Promise<Response<Journal>>
A response of created journal.

delete

delete(journalId: number): Promise<void>

- Defined in admin-api/src/clients/JournalClient.ts:69
Deletes a journal by id.

Parameters
- journalId: number
  
  journal id
Returns Promise<void>

latest

latest(top: number): Promise<Response<Journal[]>>

- Defined in admin-api/src/clients/JournalClient.ts:31
Gets latest journals.

Parameters
- top: number
  
  top option for queries
Returns Promise<Response<Journal[]>>
A response of lastes journals.

list

list(params: JournalQuery): Promise<Response<Page<JournalWithCmtCount>>>

- Defined in admin-api/src/clients/JournalClient.ts:18
Lists journals.

Parameters
- params: JournalQuery
  
  parameter for queries
Returns Promise<Response<Page<JournalWithCmtCount>>>
A page response of journals.

update

update(journalId: number, params: JournalParam): Promise<Response<Journal>>

- Defined in admin-api/src/clients/JournalClient.ts:58
Updates a journal by id.

Parameters
- journalId: number
  
  journal id
- params: JournalParam
  
  parameter for updates
Returns Promise<Response<Journal>>
A response of updated journal.

Generated using TypeDoc