ca902c3ecf
Mirrors what npm run generate:api would emit against the StatsDTO record (all three @Schema(REQUIRED) annotations). Round-1 fix only updated totalStories; this brings the other two into line. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
5167 lines
134 KiB
TypeScript
5167 lines
134 KiB
TypeScript
/**
|
|
* This file was auto-generated by openapi-typescript.
|
|
* Do not make direct changes to the file.
|
|
*/
|
|
|
|
export interface paths {
|
|
"/api/users/{id}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getUser"];
|
|
put: operations["adminUpdateUser"];
|
|
post?: never;
|
|
delete: operations["deleteUser"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/users/me": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getCurrentUser"];
|
|
put: operations["updateProfile"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/users/me/notification-preferences": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getPreferences"];
|
|
put: operations["updatePreferences"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/tags/{id}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put: operations["updateTag"];
|
|
post?: never;
|
|
delete: operations["deleteTag"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/persons/{id}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getPerson"];
|
|
put: operations["updatePerson"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{id}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getDocument"];
|
|
put: operations["updateDocument"];
|
|
post?: never;
|
|
delete: operations["deleteDocument"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{documentId}/transcription-blocks/{blockId}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getBlock"];
|
|
put: operations["updateBlock"];
|
|
post?: never;
|
|
delete: operations["deleteBlock"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{documentId}/transcription-blocks/{blockId}/review": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put: operations["reviewBlock"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{documentId}/transcription-blocks/review-all": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put: operations["markAllBlocksReviewed"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{documentId}/transcription-blocks/reorder": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put: operations["reorderBlocks"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/users": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getAllUsers"];
|
|
put?: never;
|
|
post: operations["createUser"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/users/me/password": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["changePassword"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/tags/{id}/merge": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["mergeTag"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/persons": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getPersons"];
|
|
put?: never;
|
|
post: operations["createPerson"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/persons/{id}/relationships": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getRelationships"];
|
|
put?: never;
|
|
post: operations["addRelationship"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/persons/{id}/merge": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["mergePerson"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/persons/{id}/aliases": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getAliases"];
|
|
put?: never;
|
|
post: operations["addAlias"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/ocr/train": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["triggerTraining"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/ocr/train-sender": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["triggerSenderTraining"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/ocr/segtrain": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["triggerSegTraining"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/ocr/batch": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["triggerBatch"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/notifications/read-all": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["markAllRead"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/invites": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["listInvites"];
|
|
put?: never;
|
|
post: operations["createInvite"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/groups": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getAllGroups"];
|
|
put?: never;
|
|
post: operations["createGroup"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/geschichten": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["list"];
|
|
put?: never;
|
|
post: operations["create"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["createDocument"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{id}/file": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getDocumentFile"];
|
|
put?: never;
|
|
post: operations["attachFile"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{documentId}/transcription-blocks": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["listBlocks"];
|
|
put?: never;
|
|
post: operations["createBlock"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{documentId}/transcription-blocks/{blockId}/comments": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getBlockComments"];
|
|
put?: never;
|
|
post: operations["postBlockComment"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{documentId}/transcription-blocks/{blockId}/comments/{commentId}/replies": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["replyToBlockComment"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{documentId}/ocr": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["triggerOcr"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{documentId}/annotations": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["listAnnotations"];
|
|
put?: never;
|
|
post: operations["createAnnotation"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/quick-upload": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["quickUpload"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/batch-metadata": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["batchMetadata"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/auth/reset-password": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["resetPassword"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/auth/register": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["register"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/auth/forgot-password": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["forgotPassword"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/admin/trigger-import": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["triggerMassImport"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/admin/generate-thumbnails": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["generateThumbnails"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/admin/backfill-versions": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["backfillVersions"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/admin/backfill-file-hashes": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post: operations["backfillFileHashes"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/persons/{id}/family-member": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch: operations["patchFamilyMember"];
|
|
trace?: never;
|
|
};
|
|
"/api/notifications/{id}/read": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch: operations["markOneRead"];
|
|
trace?: never;
|
|
};
|
|
"/api/groups/{id}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
delete: operations["deleteGroup"];
|
|
options?: never;
|
|
head?: never;
|
|
patch: operations["updateGroup"];
|
|
trace?: never;
|
|
};
|
|
"/api/geschichten/{id}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getById"];
|
|
put?: never;
|
|
post?: never;
|
|
delete: operations["delete"];
|
|
options?: never;
|
|
head?: never;
|
|
patch: operations["update"];
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{id}/training-labels": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch: operations["patchTrainingLabel"];
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{documentId}/comments/{commentId}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
delete: operations["deleteComment"];
|
|
options?: never;
|
|
head?: never;
|
|
patch: operations["editComment"];
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{documentId}/annotations/{annotationId}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
delete: operations["deleteAnnotation"];
|
|
options?: never;
|
|
head?: never;
|
|
patch: operations["updateAnnotation"];
|
|
trace?: never;
|
|
};
|
|
"/api/documents/bulk": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch: operations["patchBulk"];
|
|
trace?: never;
|
|
};
|
|
"/api/users/search": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["search"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/transcription/weekly-stats": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getWeeklyStats"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/transcription/transcription-queue": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getTranscriptionQueue"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/transcription/segmentation-queue": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getSegmentationQueue"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/transcription/ready-to-read": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getReadyToRead"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/tags": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["searchTags"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/tags/tree": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getTagTree"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/stats": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getStats"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/persons/{id}/received-documents": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getPersonReceivedDocuments"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/persons/{id}/inferred-relationships": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getInferredRelationships"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/persons/{id}/documents": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getPersonDocuments"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/persons/{id}/correspondents": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getCorrespondents"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/persons/{aId}/relationship-to/{bId}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getRelationshipBetween"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/ocr/training-info": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getTrainingInfo"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/ocr/training-info/{personId}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getSenderTrainingHistory"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/ocr/training-info/global": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getGlobalTrainingHistory"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/ocr/training-data/export": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["exportTrainingData"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/ocr/segmentation-training-data/export": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["exportSegmentationTrainingData"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/ocr/jobs/{jobId}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getJobStatus"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/ocr/jobs/{jobId}/progress": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["streamProgress"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/notifications": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getNotifications"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/notifications/unread-count": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["countUnread"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/notifications/stream": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["stream"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/network": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getNetwork"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{id}/versions": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getVersions"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{id}/versions/{versionId}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getVersion"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{id}/thumbnail": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getDocumentThumbnail"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{documentId}/transcription-blocks/{blockId}/history": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getBlockHistory"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/{documentId}/ocr-status": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getDocumentOcrStatus"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/search": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["search_1"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/incomplete": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getIncomplete"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/incomplete/next": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getNextIncomplete"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/incomplete-count": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getIncompleteCount"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/ids": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getDocumentIds"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/documents/conversation": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getConversation"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/dashboard/resume": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getResume"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/dashboard/pulse": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getPulse"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/dashboard/activity": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getActivity"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/auth/invite/{code}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["getInvitePrefill"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/admin/thumbnail-status": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["thumbnailStatus"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/admin/import-status": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get: operations["importStatus"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/tags/{id}/subtree": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
delete: operations["deleteSubtree"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/persons/{id}/relationships/{relId}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
delete: operations["deleteRelationship"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/persons/{id}/aliases/{aliasId}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
delete: operations["removeAlias"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/invites/{id}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
delete: operations["revokeInvite"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
}
|
|
export type webhooks = Record<string, never>;
|
|
export interface components {
|
|
schemas: {
|
|
AdminUpdateUserRequest: {
|
|
firstName?: string;
|
|
lastName?: string;
|
|
/** Format: date */
|
|
birthDate?: string;
|
|
email?: string;
|
|
contact?: string;
|
|
newPassword?: string;
|
|
groupIds?: string[];
|
|
};
|
|
AppUser: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: email */
|
|
email: string;
|
|
password?: string;
|
|
firstName?: string;
|
|
lastName?: string;
|
|
/** Format: date */
|
|
birthDate?: string;
|
|
contact?: string;
|
|
enabled: boolean;
|
|
notifyOnReply: boolean;
|
|
notifyOnMention: boolean;
|
|
groups: components["schemas"]["UserGroup"][];
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
color: string;
|
|
};
|
|
UserGroup: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
name: string;
|
|
permissions: string[];
|
|
};
|
|
UpdateProfileDTO: {
|
|
firstName?: string;
|
|
lastName?: string;
|
|
/** Format: date */
|
|
birthDate?: string;
|
|
email?: string;
|
|
contact?: string;
|
|
};
|
|
NotificationPreferenceDTO: {
|
|
notifyOnReply?: boolean;
|
|
notifyOnMention?: boolean;
|
|
};
|
|
TagUpdateDTO: {
|
|
name?: string;
|
|
/** Format: uuid */
|
|
parentId?: string;
|
|
color?: string;
|
|
};
|
|
Tag: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
name: string;
|
|
/** Format: uuid */
|
|
parentId?: string;
|
|
color?: string;
|
|
};
|
|
PersonUpdateDTO: {
|
|
/** @enum {string} */
|
|
personType: "PERSON" | "INSTITUTION" | "GROUP" | "UNKNOWN" | "SKIP";
|
|
title?: string;
|
|
firstName?: string;
|
|
lastName?: string;
|
|
alias?: string;
|
|
notes?: string;
|
|
/** Format: int32 */
|
|
birthYear?: number;
|
|
/** Format: int32 */
|
|
deathYear?: number;
|
|
};
|
|
Person: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
title?: string;
|
|
firstName?: string;
|
|
lastName: string;
|
|
/** @enum {string} */
|
|
personType: "PERSON" | "INSTITUTION" | "GROUP" | "UNKNOWN" | "SKIP";
|
|
alias?: string;
|
|
notes?: string;
|
|
/** Format: int32 */
|
|
birthYear?: number;
|
|
/** Format: int32 */
|
|
deathYear?: number;
|
|
familyMember: boolean;
|
|
readonly displayName: string;
|
|
};
|
|
DocumentUpdateDTO: {
|
|
title?: string;
|
|
/** Format: date */
|
|
documentDate?: string;
|
|
location?: string;
|
|
documentLocation?: string;
|
|
archiveBox?: string;
|
|
archiveFolder?: string;
|
|
transcription?: string;
|
|
summary?: string;
|
|
/** Format: uuid */
|
|
senderId?: string;
|
|
receiverIds?: string[];
|
|
tags?: string;
|
|
metadataComplete?: boolean;
|
|
/** @enum {string} */
|
|
scriptType?: "UNKNOWN" | "TYPEWRITER" | "HANDWRITING_LATIN" | "HANDWRITING_KURRENT";
|
|
};
|
|
Document: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
title: string;
|
|
filePath?: string;
|
|
contentType?: string;
|
|
fileHash?: string;
|
|
thumbnailKey?: string;
|
|
/** Format: date-time */
|
|
thumbnailGeneratedAt?: string;
|
|
/** @enum {string} */
|
|
thumbnailAspect?: "PORTRAIT" | "LANDSCAPE";
|
|
/** Format: int32 */
|
|
pageCount?: number;
|
|
originalFilename: string;
|
|
/** @enum {string} */
|
|
status: "PLACEHOLDER" | "UPLOADED" | "TRANSCRIBED" | "REVIEWED" | "ARCHIVED";
|
|
/** Format: date */
|
|
documentDate?: string;
|
|
location?: string;
|
|
documentLocation?: string;
|
|
archiveBox?: string;
|
|
archiveFolder?: string;
|
|
transcription?: string;
|
|
summary?: string;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
/** Format: date-time */
|
|
updatedAt: string;
|
|
metadataComplete: boolean;
|
|
/** @enum {string} */
|
|
scriptType: "UNKNOWN" | "TYPEWRITER" | "HANDWRITING_LATIN" | "HANDWRITING_KURRENT";
|
|
receivers?: components["schemas"]["Person"][];
|
|
sender?: components["schemas"]["Person"];
|
|
tags?: components["schemas"]["Tag"][];
|
|
trainingLabels?: ("KURRENT_RECOGNITION" | "KURRENT_SEGMENTATION")[];
|
|
thumbnailUrl?: string;
|
|
};
|
|
PersonMention: {
|
|
/** Format: uuid */
|
|
personId: string;
|
|
displayName: string;
|
|
};
|
|
UpdateTranscriptionBlockDTO: {
|
|
text?: string;
|
|
label?: string;
|
|
mentionedPersons?: components["schemas"]["PersonMention"][];
|
|
};
|
|
TranscriptionBlock: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: uuid */
|
|
annotationId: string;
|
|
/** Format: uuid */
|
|
documentId: string;
|
|
text?: string;
|
|
mentionedPersons: components["schemas"]["PersonMention"][];
|
|
label?: string;
|
|
/** Format: int32 */
|
|
sortOrder: number;
|
|
/** @enum {string} */
|
|
source: "MANUAL" | "OCR";
|
|
reviewed: boolean;
|
|
/** Format: int32 */
|
|
version: number;
|
|
/** Format: uuid */
|
|
createdBy?: string;
|
|
/** Format: uuid */
|
|
updatedBy?: string;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
/** Format: date-time */
|
|
updatedAt: string;
|
|
};
|
|
ReorderTranscriptionBlocksDTO: {
|
|
blockIds?: string[];
|
|
};
|
|
CreateUserRequest: {
|
|
/** Format: email */
|
|
email: string;
|
|
initialPassword?: string;
|
|
groupIds?: string[];
|
|
firstName?: string;
|
|
lastName?: string;
|
|
/** Format: date */
|
|
birthDate?: string;
|
|
contact?: string;
|
|
};
|
|
ChangePasswordDTO: {
|
|
currentPassword?: string;
|
|
newPassword?: string;
|
|
};
|
|
MergeTagDTO: {
|
|
/** Format: uuid */
|
|
targetId: string;
|
|
};
|
|
CreateRelationshipRequest: {
|
|
/** Format: uuid */
|
|
relatedPersonId: string;
|
|
/** @enum {string} */
|
|
relationType: "PARENT_OF" | "SPOUSE_OF" | "SIBLING_OF" | "FRIEND" | "COLLEAGUE" | "EMPLOYER" | "DOCTOR" | "NEIGHBOR" | "OTHER";
|
|
/** Format: int32 */
|
|
fromYear?: number;
|
|
/** Format: int32 */
|
|
toYear?: number;
|
|
notes?: string;
|
|
};
|
|
RelationshipDTO: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: uuid */
|
|
personId: string;
|
|
/** Format: uuid */
|
|
relatedPersonId: string;
|
|
personDisplayName: string;
|
|
/** Format: int32 */
|
|
personBirthYear?: number;
|
|
/** Format: int32 */
|
|
personDeathYear?: number;
|
|
relatedPersonDisplayName: string;
|
|
/** Format: int32 */
|
|
relatedPersonBirthYear?: number;
|
|
/** Format: int32 */
|
|
relatedPersonDeathYear?: number;
|
|
/** @enum {string} */
|
|
relationType: "PARENT_OF" | "SPOUSE_OF" | "SIBLING_OF" | "FRIEND" | "COLLEAGUE" | "EMPLOYER" | "DOCTOR" | "NEIGHBOR" | "OTHER";
|
|
/** Format: int32 */
|
|
fromYear?: number;
|
|
/** Format: int32 */
|
|
toYear?: number;
|
|
notes?: string;
|
|
};
|
|
PersonNameAliasDTO: {
|
|
lastName: string;
|
|
firstName?: string;
|
|
/** @enum {string} */
|
|
type: "BIRTH" | "WIDOWED" | "DIVORCED" | "MAIDEN_NAME" | "OTHER";
|
|
};
|
|
PersonNameAlias: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
lastName: string;
|
|
firstName?: string;
|
|
/** @enum {string} */
|
|
type: "BIRTH" | "WIDOWED" | "DIVORCED" | "MAIDEN_NAME" | "OTHER";
|
|
/** Format: int32 */
|
|
sortOrder: number;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
};
|
|
OcrTrainingRun: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** @enum {string} */
|
|
status: "QUEUED" | "RUNNING" | "DONE" | "FAILED";
|
|
/** Format: int32 */
|
|
blockCount: number;
|
|
/** Format: int32 */
|
|
documentCount: number;
|
|
modelName: string;
|
|
/** Format: double */
|
|
cer?: number;
|
|
/** Format: double */
|
|
loss?: number;
|
|
/** Format: double */
|
|
accuracy?: number;
|
|
/** Format: int32 */
|
|
epochs?: number;
|
|
errorMessage?: string;
|
|
/** Format: uuid */
|
|
triggeredBy?: string;
|
|
/** Format: uuid */
|
|
personId?: string;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
/** Format: date-time */
|
|
completedAt?: string;
|
|
};
|
|
TriggerSenderTrainingDTO: {
|
|
/** Format: uuid */
|
|
personId: string;
|
|
};
|
|
BatchOcrDTO: {
|
|
documentIds: string[];
|
|
};
|
|
CreateInviteRequest: {
|
|
label?: string;
|
|
/** Format: int32 */
|
|
maxUses?: number;
|
|
prefillFirstName?: string;
|
|
prefillLastName?: string;
|
|
prefillEmail?: string;
|
|
groupIds?: string[];
|
|
/** Format: date-time */
|
|
expiresAt?: string;
|
|
};
|
|
InviteListItemDTO: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
code: string;
|
|
displayCode: string;
|
|
label?: string;
|
|
/** Format: int32 */
|
|
useCount: number;
|
|
/** Format: int32 */
|
|
maxUses?: number;
|
|
/** Format: date-time */
|
|
expiresAt?: string;
|
|
revoked: boolean;
|
|
status: string;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
shareableUrl?: string;
|
|
};
|
|
GroupDTO: {
|
|
name?: string;
|
|
permissions?: string[];
|
|
};
|
|
GeschichteUpdateDTO: {
|
|
title?: string;
|
|
body?: string;
|
|
/** @enum {string} */
|
|
status?: "DRAFT" | "PUBLISHED";
|
|
personIds?: string[];
|
|
documentIds?: string[];
|
|
};
|
|
Geschichte: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
title: string;
|
|
body?: string;
|
|
/** @enum {string} */
|
|
status: "DRAFT" | "PUBLISHED";
|
|
author?: components["schemas"]["AppUser"];
|
|
persons?: components["schemas"]["Person"][];
|
|
documents?: components["schemas"]["Document"][];
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
/** Format: date-time */
|
|
updatedAt: string;
|
|
/** Format: date-time */
|
|
publishedAt?: string;
|
|
};
|
|
CreateTranscriptionBlockDTO: {
|
|
/** Format: int32 */
|
|
pageNumber?: number;
|
|
/** Format: double */
|
|
x?: number;
|
|
/** Format: double */
|
|
y?: number;
|
|
/** Format: double */
|
|
width?: number;
|
|
/** Format: double */
|
|
height?: number;
|
|
text?: string;
|
|
label?: string;
|
|
mentionedPersons?: components["schemas"]["PersonMention"][];
|
|
};
|
|
CreateCommentDTO: {
|
|
content?: string;
|
|
mentionedUserIds?: string[];
|
|
};
|
|
DocumentComment: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: uuid */
|
|
documentId: string;
|
|
/** Format: uuid */
|
|
annotationId?: string;
|
|
/** Format: uuid */
|
|
blockId?: string;
|
|
/** Format: uuid */
|
|
parentId?: string;
|
|
/** Format: uuid */
|
|
authorId?: string;
|
|
authorName: string;
|
|
content: string;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
/** Format: date-time */
|
|
updatedAt: string;
|
|
replies: components["schemas"]["DocumentComment"][];
|
|
mentionDTOs: components["schemas"]["MentionDTO"][];
|
|
};
|
|
MentionDTO: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
firstName: string;
|
|
lastName: string;
|
|
};
|
|
TriggerOcrDTO: {
|
|
/** @enum {string} */
|
|
scriptType?: "UNKNOWN" | "TYPEWRITER" | "HANDWRITING_LATIN" | "HANDWRITING_KURRENT";
|
|
useExistingAnnotations?: boolean;
|
|
};
|
|
CreateAnnotationDTO: {
|
|
/** Format: int32 */
|
|
pageNumber?: number;
|
|
/** Format: double */
|
|
x?: number;
|
|
/** Format: double */
|
|
y?: number;
|
|
/** Format: double */
|
|
width?: number;
|
|
/** Format: double */
|
|
height?: number;
|
|
color?: string;
|
|
polygon?: number[][];
|
|
};
|
|
DocumentAnnotation: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: uuid */
|
|
documentId: string;
|
|
/** Format: int32 */
|
|
pageNumber: number;
|
|
/** Format: double */
|
|
x: number;
|
|
/** Format: double */
|
|
y: number;
|
|
/** Format: double */
|
|
width: number;
|
|
/** Format: double */
|
|
height: number;
|
|
color: string;
|
|
fileHash?: string;
|
|
polygon?: number[][];
|
|
/** Format: uuid */
|
|
createdBy?: string;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
};
|
|
DocumentBatchMetadataDTO: {
|
|
titles?: string[];
|
|
/** Format: uuid */
|
|
senderId?: string;
|
|
receiverIds?: string[];
|
|
/** Format: date */
|
|
documentDate?: string;
|
|
location?: string;
|
|
tagNames?: string[];
|
|
metadataComplete?: boolean;
|
|
};
|
|
QuickUploadResult: {
|
|
created?: components["schemas"]["Document"][];
|
|
updated?: components["schemas"]["Document"][];
|
|
errors?: components["schemas"]["UploadError"][];
|
|
};
|
|
UploadError: {
|
|
filename?: string;
|
|
code?: string;
|
|
};
|
|
BatchMetadataRequest: {
|
|
ids: string[];
|
|
};
|
|
DocumentBatchSummary: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
title: string;
|
|
pdfUrl: string;
|
|
};
|
|
ResetPasswordRequest: {
|
|
token?: string;
|
|
newPassword?: string;
|
|
};
|
|
RegisterRequest: {
|
|
code: string;
|
|
/** Format: email */
|
|
email: string;
|
|
password: string;
|
|
firstName?: string;
|
|
lastName?: string;
|
|
notifyOnMention?: boolean;
|
|
};
|
|
ForgotPasswordRequest: {
|
|
email?: string;
|
|
};
|
|
ImportStatus: {
|
|
/** @enum {string} */
|
|
state?: "IDLE" | "RUNNING" | "DONE" | "FAILED";
|
|
message?: string;
|
|
/** Format: int32 */
|
|
processed?: number;
|
|
/** Format: date-time */
|
|
startedAt?: string;
|
|
};
|
|
BackfillStatus: {
|
|
/** @enum {string} */
|
|
state?: "IDLE" | "RUNNING" | "DONE" | "FAILED";
|
|
message?: string;
|
|
/** Format: int32 */
|
|
total?: number;
|
|
/** Format: int32 */
|
|
processed?: number;
|
|
/** Format: int32 */
|
|
skipped?: number;
|
|
/** Format: int32 */
|
|
failed?: number;
|
|
/** Format: date-time */
|
|
startedAt?: string;
|
|
};
|
|
BackfillResult: {
|
|
/** Format: int32 */
|
|
count: number;
|
|
};
|
|
FamilyMemberPatchDTO: {
|
|
familyMember?: boolean;
|
|
};
|
|
NotificationDTO: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** @enum {string} */
|
|
type: "REPLY" | "MENTION";
|
|
/** Format: uuid */
|
|
documentId?: string;
|
|
/** Format: uuid */
|
|
referenceId?: string;
|
|
/** Format: uuid */
|
|
annotationId?: string;
|
|
read: boolean;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
actorName?: string;
|
|
documentTitle?: string;
|
|
};
|
|
TrainingLabelRequest: {
|
|
label?: string;
|
|
enrolled?: boolean;
|
|
};
|
|
UpdateAnnotationDTO: {
|
|
/** Format: double */
|
|
x?: number;
|
|
/** Format: double */
|
|
y?: number;
|
|
/** Format: double */
|
|
width?: number;
|
|
/** Format: double */
|
|
height?: number;
|
|
};
|
|
DocumentBulkEditDTO: {
|
|
documentIds?: string[];
|
|
tagNames?: string[];
|
|
/** Format: uuid */
|
|
senderId?: string;
|
|
receiverIds?: string[];
|
|
documentLocation?: string;
|
|
archiveBox?: string;
|
|
archiveFolder?: string;
|
|
};
|
|
BulkEditError: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
message: string;
|
|
};
|
|
BulkEditResult: {
|
|
/** Format: int32 */
|
|
updated: number;
|
|
errors: components["schemas"]["BulkEditError"][];
|
|
};
|
|
TranscriptionWeeklyStatsDTO: {
|
|
/** Format: int64 */
|
|
segmentationCount: number;
|
|
/** Format: int64 */
|
|
transcriptionCount: number;
|
|
};
|
|
ActivityActorDTO: {
|
|
initials: string;
|
|
color: string;
|
|
name?: string;
|
|
};
|
|
TranscriptionQueueItemDTO: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
title: string;
|
|
/** Format: date */
|
|
documentDate?: string;
|
|
/** Format: int32 */
|
|
annotationCount: number;
|
|
/** Format: int32 */
|
|
textedBlockCount: number;
|
|
/** Format: int32 */
|
|
reviewedBlockCount: number;
|
|
contributors: components["schemas"]["ActivityActorDTO"][];
|
|
hasMoreContributors: boolean;
|
|
};
|
|
TagTreeNodeDTO: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
name: string;
|
|
color?: string;
|
|
/** Format: int32 */
|
|
documentCount: number;
|
|
children?: components["schemas"]["TagTreeNodeDTO"][];
|
|
/**
|
|
* Format: uuid
|
|
* @description Parent tag ID, null for root tags
|
|
*/
|
|
parentId?: string;
|
|
};
|
|
StatsDTO: {
|
|
/** Format: int64 */
|
|
totalPersons: number;
|
|
/** Format: int64 */
|
|
totalDocuments: number;
|
|
/** Format: int64 */
|
|
totalStories: number;
|
|
};
|
|
PersonSummaryDTO: {
|
|
title?: string;
|
|
/** Format: uuid */
|
|
id?: string;
|
|
displayName?: string;
|
|
firstName?: string;
|
|
lastName?: string;
|
|
personType?: string;
|
|
/** Format: int32 */
|
|
birthYear?: number;
|
|
/** Format: int32 */
|
|
deathYear?: number;
|
|
familyMember?: boolean;
|
|
notes?: string;
|
|
alias?: string;
|
|
/** Format: int64 */
|
|
documentCount?: number;
|
|
};
|
|
InferredRelationshipWithPersonDTO: {
|
|
person: components["schemas"]["PersonNodeDTO"];
|
|
label: string;
|
|
/** Format: int32 */
|
|
hops: number;
|
|
};
|
|
PersonNodeDTO: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
displayName: string;
|
|
/** Format: int32 */
|
|
birthYear?: number;
|
|
/** Format: int32 */
|
|
deathYear?: number;
|
|
familyMember: boolean;
|
|
};
|
|
InferredRelationshipDTO: {
|
|
labelFromA: string;
|
|
labelFromB: string;
|
|
/** Format: int32 */
|
|
hops: number;
|
|
};
|
|
SenderModel: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: uuid */
|
|
personId: string;
|
|
/** Format: double */
|
|
accuracy?: number;
|
|
/** Format: double */
|
|
cer?: number;
|
|
/** Format: int32 */
|
|
correctedLinesAtTraining: number;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
/** Format: date-time */
|
|
updatedAt: string;
|
|
};
|
|
TrainingInfoResponse: {
|
|
/** Format: int32 */
|
|
availableBlocks?: number;
|
|
/** Format: int32 */
|
|
totalOcrBlocks?: number;
|
|
/** Format: int32 */
|
|
availableDocuments?: number;
|
|
/** Format: int32 */
|
|
availableSegBlocks?: number;
|
|
ocrServiceAvailable?: boolean;
|
|
lastRun?: components["schemas"]["OcrTrainingRun"];
|
|
runs?: components["schemas"]["OcrTrainingRun"][];
|
|
personNames?: {
|
|
[key: string]: string;
|
|
};
|
|
senderModels?: components["schemas"]["SenderModel"][];
|
|
};
|
|
TrainingHistoryResponse: {
|
|
runs?: components["schemas"]["OcrTrainingRun"][];
|
|
personNames?: {
|
|
[key: string]: string;
|
|
};
|
|
};
|
|
StreamingResponseBody: unknown;
|
|
OcrJob: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** @enum {string} */
|
|
status: "PENDING" | "RUNNING" | "DONE" | "FAILED";
|
|
/** Format: int32 */
|
|
totalDocuments: number;
|
|
/** Format: int32 */
|
|
processedDocuments: number;
|
|
/** Format: int32 */
|
|
errorCount: number;
|
|
/** Format: int32 */
|
|
skippedCount: number;
|
|
progressMessage?: string;
|
|
/** Format: uuid */
|
|
createdBy?: string;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
/** Format: date-time */
|
|
updatedAt: string;
|
|
};
|
|
SseEmitter: {
|
|
/** Format: int64 */
|
|
timeout?: number;
|
|
};
|
|
PageNotificationDTO: {
|
|
/** Format: int64 */
|
|
totalElements?: number;
|
|
/** Format: int32 */
|
|
totalPages?: number;
|
|
pageable?: components["schemas"]["PageableObject"];
|
|
first?: boolean;
|
|
last?: boolean;
|
|
/** Format: int32 */
|
|
size?: number;
|
|
content?: components["schemas"]["NotificationDTO"][];
|
|
/** Format: int32 */
|
|
number?: number;
|
|
sort?: components["schemas"]["SortObject"];
|
|
/** Format: int32 */
|
|
numberOfElements?: number;
|
|
empty?: boolean;
|
|
};
|
|
PageableObject: {
|
|
paged?: boolean;
|
|
/** Format: int32 */
|
|
pageNumber?: number;
|
|
/** Format: int32 */
|
|
pageSize?: number;
|
|
/** Format: int64 */
|
|
offset?: number;
|
|
sort?: components["schemas"]["SortObject"];
|
|
unpaged?: boolean;
|
|
};
|
|
SortObject: {
|
|
sorted?: boolean;
|
|
empty?: boolean;
|
|
unsorted?: boolean;
|
|
};
|
|
NetworkDTO: {
|
|
nodes: components["schemas"]["PersonNodeDTO"][];
|
|
edges: components["schemas"]["RelationshipDTO"][];
|
|
};
|
|
DocumentVersionSummary: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: date-time */
|
|
savedAt: string;
|
|
editorName: string;
|
|
changedFields: string[];
|
|
};
|
|
DocumentVersion: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: uuid */
|
|
documentId: string;
|
|
/** Format: date-time */
|
|
savedAt: string;
|
|
/** Format: uuid */
|
|
editorId?: string;
|
|
editorName: string;
|
|
snapshot: string;
|
|
changedFields: string;
|
|
};
|
|
TranscriptionBlockVersion: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: uuid */
|
|
blockId: string;
|
|
text: string;
|
|
/** Format: uuid */
|
|
changedBy?: string;
|
|
/** Format: date-time */
|
|
changedAt: string;
|
|
};
|
|
OcrStatusDTO: {
|
|
status?: string;
|
|
/** Format: uuid */
|
|
jobId?: string;
|
|
/** Format: int32 */
|
|
currentPage?: number;
|
|
/** Format: int32 */
|
|
totalPages?: number;
|
|
};
|
|
DocumentSearchItem: {
|
|
document: components["schemas"]["Document"];
|
|
matchData: components["schemas"]["SearchMatchData"];
|
|
/** Format: int32 */
|
|
completionPercentage: number;
|
|
contributors: components["schemas"]["ActivityActorDTO"][];
|
|
};
|
|
DocumentSearchResult: {
|
|
items: components["schemas"]["DocumentSearchItem"][];
|
|
/** Format: int64 */
|
|
totalElements: number;
|
|
/** Format: int32 */
|
|
pageNumber: number;
|
|
/** Format: int32 */
|
|
pageSize: number;
|
|
/** Format: int32 */
|
|
totalPages: number;
|
|
};
|
|
MatchOffset: {
|
|
/** Format: int32 */
|
|
start: number;
|
|
/** Format: int32 */
|
|
length: number;
|
|
};
|
|
SearchMatchData: {
|
|
transcriptionSnippet?: string;
|
|
titleOffsets: components["schemas"]["MatchOffset"][];
|
|
senderMatched: boolean;
|
|
matchedReceiverIds: string[];
|
|
matchedTagIds: string[];
|
|
snippetOffsets: components["schemas"]["MatchOffset"][];
|
|
summarySnippet?: string;
|
|
summaryOffsets: components["schemas"]["MatchOffset"][];
|
|
};
|
|
IncompleteDocumentDTO: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
title: string;
|
|
/** Format: date-time */
|
|
uploadedAt: string;
|
|
};
|
|
DashboardResumeDTO: {
|
|
/** Format: uuid */
|
|
documentId: string;
|
|
title: string;
|
|
caption: string;
|
|
excerpt: string;
|
|
/** Format: int32 */
|
|
totalBlocks: number;
|
|
/** Format: int32 */
|
|
pct: number;
|
|
thumbnailUrl?: string;
|
|
collaborators: components["schemas"]["ActivityActorDTO"][];
|
|
};
|
|
DashboardPulseDTO: {
|
|
/** Format: int32 */
|
|
pages: number;
|
|
/** Format: int32 */
|
|
annotated: number;
|
|
/** Format: int32 */
|
|
transcribed: number;
|
|
/** Format: int32 */
|
|
uploaded: number;
|
|
/** Format: int32 */
|
|
yourPages: number;
|
|
contributors: components["schemas"]["ActivityActorDTO"][];
|
|
};
|
|
ActivityFeedItemDTO: {
|
|
/** @enum {string} */
|
|
kind: "FILE_UPLOADED" | "STATUS_CHANGED" | "METADATA_UPDATED" | "TEXT_SAVED" | "BLOCK_REVIEWED" | "ANNOTATION_CREATED" | "COMMENT_ADDED" | "MENTION_CREATED" | "USER_CREATED" | "USER_DELETED" | "GROUP_MEMBERSHIP_CHANGED";
|
|
actor?: components["schemas"]["ActivityActorDTO"];
|
|
/** Format: uuid */
|
|
documentId: string;
|
|
documentTitle: string;
|
|
/** Format: date-time */
|
|
happenedAt: string;
|
|
youMentioned: boolean;
|
|
youParticipated: boolean;
|
|
/** Format: int32 */
|
|
count: number;
|
|
/** Format: date-time */
|
|
happenedAtUntil?: string;
|
|
/**
|
|
* Format: uuid
|
|
* @description Deep-link target comment; populated only for COMMENT_ADDED and MENTION_CREATED kinds.
|
|
*/
|
|
commentId?: string;
|
|
/**
|
|
* Format: uuid
|
|
* @description Annotation associated with the comment; populated only for COMMENT_ADDED and MENTION_CREATED kinds.
|
|
*/
|
|
annotationId?: string;
|
|
};
|
|
InvitePrefillDTO: {
|
|
firstName: string;
|
|
lastName: string;
|
|
email: string;
|
|
};
|
|
};
|
|
responses: never;
|
|
parameters: never;
|
|
requestBodies: never;
|
|
headers: never;
|
|
pathItems: never;
|
|
}
|
|
export type $defs = Record<string, never>;
|
|
export interface operations {
|
|
getUser: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["AppUser"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
adminUpdateUser: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["AdminUpdateUserRequest"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["AppUser"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
deleteUser: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
getCurrentUser: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["AppUser"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
updateProfile: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["UpdateProfileDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["AppUser"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getPreferences: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["NotificationPreferenceDTO"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
updatePreferences: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["NotificationPreferenceDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["NotificationPreferenceDTO"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
updateTag: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["TagUpdateDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Tag"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
deleteTag: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
getPerson: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Person"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
updatePerson: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["PersonUpdateDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Person"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getDocument: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Document"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
updateDocument: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: {
|
|
content: {
|
|
"multipart/form-data": components["schemas"]["DocumentUpdateDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Document"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
deleteDocument: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
getBlock: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
blockId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TranscriptionBlock"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
updateBlock: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
blockId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["UpdateTranscriptionBlockDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TranscriptionBlock"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
deleteBlock: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
blockId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description No Content */
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
reviewBlock: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
blockId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TranscriptionBlock"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
markAllBlocksReviewed: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TranscriptionBlock"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
reorderBlocks: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["ReorderTranscriptionBlocksDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TranscriptionBlock"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getAllUsers: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["AppUser"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
createUser: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateUserRequest"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["AppUser"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
changePassword: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["ChangePasswordDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description No Content */
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
mergeTag: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["MergeTagDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Tag"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getPersons: {
|
|
parameters: {
|
|
query?: {
|
|
q?: string;
|
|
size?: number;
|
|
sort?: string;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["PersonSummaryDTO"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
createPerson: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["PersonUpdateDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Person"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getRelationships: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["RelationshipDTO"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
addRelationship: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateRelationshipRequest"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["RelationshipDTO"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
mergePerson: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": {
|
|
[key: string]: string;
|
|
};
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description No Content */
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
getAliases: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["PersonNameAlias"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
addAlias: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["PersonNameAliasDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["PersonNameAlias"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
triggerTraining: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Created */
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["OcrTrainingRun"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
triggerSenderTraining: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["TriggerSenderTrainingDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Accepted */
|
|
202: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["OcrTrainingRun"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
triggerSegTraining: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Created */
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["OcrTrainingRun"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
triggerBatch: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["BatchOcrDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Accepted */
|
|
202: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": {
|
|
[key: string]: string;
|
|
};
|
|
};
|
|
};
|
|
};
|
|
};
|
|
markAllRead: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description No Content */
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
listInvites: {
|
|
parameters: {
|
|
query?: {
|
|
status?: string;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["InviteListItemDTO"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
createInvite: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateInviteRequest"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["InviteListItemDTO"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getAllGroups: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["UserGroup"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
createGroup: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["GroupDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["UserGroup"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
list: {
|
|
parameters: {
|
|
query?: {
|
|
status?: "DRAFT" | "PUBLISHED";
|
|
personId?: string[];
|
|
documentId?: string;
|
|
limit?: number;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Geschichte"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
create: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["GeschichteUpdateDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Geschichte"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
createDocument: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: {
|
|
content: {
|
|
"multipart/form-data": components["schemas"]["DocumentUpdateDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Document"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getDocumentFile: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": string;
|
|
};
|
|
};
|
|
};
|
|
};
|
|
attachFile: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: {
|
|
content: {
|
|
"multipart/form-data": {
|
|
/** Format: binary */
|
|
file: string;
|
|
};
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Document"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
listBlocks: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TranscriptionBlock"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
createBlock: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateTranscriptionBlockDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Created */
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TranscriptionBlock"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getBlockComments: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
blockId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["DocumentComment"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
postBlockComment: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
blockId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateCommentDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Created */
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["DocumentComment"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
replyToBlockComment: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
commentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateCommentDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Created */
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["DocumentComment"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
triggerOcr: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["TriggerOcrDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Accepted */
|
|
202: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": {
|
|
[key: string]: string;
|
|
};
|
|
};
|
|
};
|
|
};
|
|
};
|
|
listAnnotations: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["DocumentAnnotation"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
createAnnotation: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateAnnotationDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Created */
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["DocumentAnnotation"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
quickUpload: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: {
|
|
content: {
|
|
"multipart/form-data": {
|
|
files?: string[];
|
|
metadata?: components["schemas"]["DocumentBatchMetadataDTO"];
|
|
};
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["QuickUploadResult"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
batchMetadata: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["BatchMetadataRequest"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["DocumentBatchSummary"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
resetPassword: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["ResetPasswordRequest"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
register: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["RegisterRequest"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["AppUser"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
forgotPassword: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["ForgotPasswordRequest"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
triggerMassImport: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["ImportStatus"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
generateThumbnails: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["BackfillStatus"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
backfillVersions: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["BackfillResult"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
backfillFileHashes: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["BackfillResult"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
patchFamilyMember: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["FamilyMemberPatchDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Person"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
markOneRead: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["NotificationDTO"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
deleteGroup: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
updateGroup: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["GroupDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["UserGroup"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getById: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Geschichte"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
delete: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
update: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["GeschichteUpdateDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Geschichte"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
patchTrainingLabel: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["TrainingLabelRequest"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description No Content */
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
deleteComment: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
commentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description No Content */
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
editComment: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
commentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateCommentDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["DocumentComment"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
deleteAnnotation: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
annotationId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description No Content */
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
updateAnnotation: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
annotationId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["UpdateAnnotationDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["DocumentAnnotation"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
patchBulk: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["DocumentBulkEditDTO"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["BulkEditResult"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
search: {
|
|
parameters: {
|
|
query?: {
|
|
q?: string;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["MentionDTO"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getWeeklyStats: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TranscriptionWeeklyStatsDTO"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getTranscriptionQueue: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TranscriptionQueueItemDTO"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getSegmentationQueue: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TranscriptionQueueItemDTO"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getReadyToRead: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TranscriptionQueueItemDTO"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
searchTags: {
|
|
parameters: {
|
|
query?: {
|
|
query?: string;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Tag"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getTagTree: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TagTreeNodeDTO"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getStats: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["StatsDTO"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getPersonReceivedDocuments: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Document"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getInferredRelationships: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["InferredRelationshipWithPersonDTO"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getPersonDocuments: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Document"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getCorrespondents: {
|
|
parameters: {
|
|
query?: {
|
|
q?: string;
|
|
};
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Person"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getRelationshipBetween: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
aId: string;
|
|
bId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["InferredRelationshipDTO"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getTrainingInfo: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TrainingInfoResponse"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getSenderTrainingHistory: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
personId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TrainingHistoryResponse"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getGlobalTrainingHistory: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TrainingHistoryResponse"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
exportTrainingData: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["StreamingResponseBody"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
exportSegmentationTrainingData: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["StreamingResponseBody"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getJobStatus: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
jobId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["OcrJob"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
streamProgress: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
jobId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"text/event-stream": components["schemas"]["SseEmitter"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getNotifications: {
|
|
parameters: {
|
|
query?: {
|
|
page?: number;
|
|
size?: number;
|
|
/** @description Filter by notification type */
|
|
type?: "REPLY" | "MENTION";
|
|
/** @description Filter by read status */
|
|
read?: boolean;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["PageNotificationDTO"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
countUnread: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": {
|
|
[key: string]: number;
|
|
};
|
|
};
|
|
};
|
|
};
|
|
};
|
|
stream: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"text/event-stream": components["schemas"]["SseEmitter"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getNetwork: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["NetworkDTO"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getVersions: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["DocumentVersionSummary"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getVersion: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
versionId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["DocumentVersion"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getDocumentThumbnail: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": string;
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getBlockHistory: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
blockId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["TranscriptionBlockVersion"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getDocumentOcrStatus: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
documentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["OcrStatusDTO"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
search_1: {
|
|
parameters: {
|
|
query?: {
|
|
q?: string;
|
|
from?: string;
|
|
to?: string;
|
|
senderId?: string;
|
|
receiverId?: string;
|
|
tag?: string[];
|
|
tagQ?: string;
|
|
/** @description Filter by document status */
|
|
status?: "PLACEHOLDER" | "UPLOADED" | "TRANSCRIBED" | "REVIEWED" | "ARCHIVED";
|
|
/** @description Sort field */
|
|
sort?: "DATE" | "TITLE" | "SENDER" | "RECEIVER" | "UPLOAD_DATE" | "UPDATED_AT" | "RELEVANCE";
|
|
/** @description Sort direction: ASC or DESC */
|
|
dir?: string;
|
|
/** @description Tag operator: AND (default) or OR */
|
|
tagOp?: string;
|
|
/** @description Page number (0-indexed) */
|
|
page?: number;
|
|
/** @description Page size (max 100) */
|
|
size?: number;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["DocumentSearchResult"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getIncomplete: {
|
|
parameters: {
|
|
query?: {
|
|
/** @description Maximum number of results (server caps at 200) */
|
|
size?: number;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["IncompleteDocumentDTO"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getNextIncomplete: {
|
|
parameters: {
|
|
query: {
|
|
excludeId: string;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Document"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getIncompleteCount: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": {
|
|
[key: string]: number;
|
|
};
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getDocumentIds: {
|
|
parameters: {
|
|
query?: {
|
|
q?: string;
|
|
from?: string;
|
|
to?: string;
|
|
senderId?: string;
|
|
receiverId?: string;
|
|
tag?: string[];
|
|
tagQ?: string;
|
|
status?: "PLACEHOLDER" | "UPLOADED" | "TRANSCRIBED" | "REVIEWED" | "ARCHIVED";
|
|
tagOp?: string;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": string[];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getConversation: {
|
|
parameters: {
|
|
query: {
|
|
senderId: string;
|
|
receiverId?: string;
|
|
from?: string;
|
|
to?: string;
|
|
dir?: string;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["Document"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getResume: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["DashboardResumeDTO"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getPulse: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["DashboardPulseDTO"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getActivity: {
|
|
parameters: {
|
|
query?: {
|
|
limit?: number;
|
|
/** @description Filter by audit kinds; omit for all rollup-eligible kinds */
|
|
kinds?: ("FILE_UPLOADED" | "STATUS_CHANGED" | "METADATA_UPDATED" | "TEXT_SAVED" | "BLOCK_REVIEWED" | "ANNOTATION_CREATED" | "COMMENT_ADDED" | "MENTION_CREATED" | "USER_CREATED" | "USER_DELETED" | "GROUP_MEMBERSHIP_CHANGED")[];
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["ActivityFeedItemDTO"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
getInvitePrefill: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
code: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["InvitePrefillDTO"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
thumbnailStatus: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["BackfillStatus"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
importStatus: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"*/*": components["schemas"]["ImportStatus"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
deleteSubtree: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description No Content */
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
deleteRelationship: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
relId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description No Content */
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
removeAlias: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
aliasId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description No Content */
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
revokeInvite: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description OK */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
}
|