Kind: Class
Source: atloria-monorepo/packages/api-client/src/endpoints/documents.ts
Document endpoints
Methods
| Method | Signature | Returns |
|---|---|---|
list | list(params: DocumentListParams) | Promise<DocumentListResponse> |
get | get(id: string) | Promise<Document> |
getBySlug | getBySlug(projectId: string, slug: string) | Promise<Document> |
create | create(dto: CreateDocumentDto) | Promise<Document> |
update | update(id: string, dto: UpdateDocumentDto) | Promise<Document> |
delete | delete(id: string) | Promise<void> |
publish | publish(id: string) | Promise<Document> |
unpublish | unpublish(id: string) | Promise<Document> |
regenerate | regenerate(id: string) | Promise<Document> |
getRevisions | getRevisions(id: string, limit: number, offset: number) | Promise<DocumentRevision[]> |
getRevision | getRevision(id: string, revisionId: string) | Promise<DocumentRevision> |
restoreRevision | restoreRevision(id: string, revisionId: string) | Promise<Document> |
Was this page helpful?