Kind: Class
Source: atloria-monorepo/packages/api-client/src/endpoints/suggestions.ts
Suggestion endpoints
All routes are nested under the owning document
(/documents/:documentId/suggestions/...) to match the API's
SuggestionController — the old flat /suggestions/:id paths never existed
server-side.
Methods
| Method | Signature | Returns |
|---|---|---|
list | list(documentId: string, params: Omit<SuggestionListParams, 'documentId'>) | Promise<SuggestionWithUser[]> |
get | get(documentId: string, suggestionId: string) | Promise<SuggestionWithUser> |
create | create(documentId: string, dto: CreateSuggestionDto) | Promise<SuggestionWithUser> |
update | update(suggestionId: string, dto: UpdateSuggestionDto) | Promise<SuggestionWithUser> |
delete | delete(documentId: string, suggestionId: string) | Promise<void> |
accept | accept(documentId: string, suggestionId: string, reviewComment: string) | Promise<SuggestionWithUser> |
reject | reject(documentId: string, suggestionId: string, reviewComment: string) | Promise<SuggestionWithUser> |
Was this page helpful?