@tstdl/base 0.92.124 → 0.92.126

package/document-management/api/document-management.api.d.ts

@@ -0,0 +1,634 @@
+import { Document, DocumentCategory, DocumentCollection, DocumentRequest, DocumentRequestsTemplate, DocumentRequestTemplate, DocumentType } from '../models/index.js';
+import { DocumentCategoryView, DocumentManagementData, DocumentRequestsTemplateData } from '../service-models/index.js';
+export type DocumentManagementApiDefinition = typeof documentManagementApiDefinition;
+export declare const documentManagementApiDefinition: {
+    resource: string;
+    endpoints: {
+        loadData: {
+            resource: string;
+            method: "GET";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                collectionIds: string | string[];
+            }>;
+            result: typeof DocumentManagementData;
+            credentials: true;
+        };
+        loadDocumentRequestsTemplateData: {
+            resource: string;
+            method: "GET";
+            result: typeof DocumentRequestsTemplateData;
+            credentials: true;
+        };
+        loadAvailableCategories: {
+            resource: string;
+            method: "GET";
+            result: import("../../schema/index.js").ArraySchema<DocumentCategoryView>;
+            credentials: true;
+        };
+        loadFileContent: {
+            resource: string;
+            method: "GET";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                title: string | null;
+                id: string;
+                download?: boolean | undefined;
+            }>;
+            result: Uint8ArrayConstructor;
+            credentials: true;
+        };
+        getFileContentUrl: {
+            resource: string;
+            method: "GET";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                title: string | null;
+                id: string;
+                download?: boolean | undefined;
+            }>;
+            result: import("../../schema/index.js").StringSchema;
+            credentials: true;
+        };
+        createCategory: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                label: string;
+                parentId: import("../../orm/schemas/uuid.js").Uuid | null;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentCategory;
+            credentials: true;
+        };
+        createType: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                label: string;
+                categoryId: import("../../orm/schemas/uuid.js").Uuid;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentType;
+            credentials: true;
+        };
+        createCollection: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                parentId: import("../../orm/schemas/uuid.js").Uuid | null;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentCollection;
+            credentials: true;
+        };
+        createDocument: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                date: import("../../orm/schemas/numeric-date.js").NumericDate | null;
+                summary: string | null;
+                title: string | null;
+                typeId: import("../../orm/schemas/uuid.js").Uuid | null;
+                subtitle: string | null;
+                tags: string[] | null;
+                comment: string | null;
+                approval: import("../models/document.model.js").DocumentApproval;
+                createUserId: import("../../orm/schemas/uuid.js").Uuid | null;
+                originalFileName: string | null;
+                assignment: {
+                    collections: string | string[];
+                } | {
+                    request: string;
+                } | {
+                    automatic: {
+                        target: "request" | "collection";
+                        scope: string | string[];
+                    };
+                };
+                properties?: {
+                    propertyId: import("../../orm/schemas/uuid.js").Uuid;
+                    value: string | number | boolean | null;
+                    metadata?: Partial<{
+                        attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                    }> | undefined;
+                }[] | undefined;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            body: Uint8ArrayConstructor;
+            maxBytes: number;
+            result: typeof Document;
+            credentials: true;
+        };
+        createDocumentRequestsTemplate: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                description: string | null;
+                label: string;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentRequestsTemplate;
+            credentials: true;
+        };
+        updateDocumentRequestsTemplate: {
+            resource: string;
+            method: "PATCH";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                description?: string | null | undefined;
+                label?: string | undefined;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentRequestsTemplate;
+            credentials: true;
+        };
+        applyDocumentRequestsTemplate: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                collectionIds: string[];
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+        deleteDocumentRequestsTemplate: {
+            resource: string;
+            method: "DELETE";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+        createDocumentRequestTemplate: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                typeId: import("../../orm/schemas/uuid.js").Uuid;
+                comment: string | null;
+                requestsTemplateId: import("../../orm/schemas/uuid.js").Uuid;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentRequestTemplate;
+            credentials: true;
+        };
+        updateDocumentRequestTemplate: {
+            resource: string;
+            method: "PATCH";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                typeId?: import("../../orm/types.js").Uuid | undefined;
+                comment?: string | null | undefined;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentRequestTemplate;
+            credentials: true;
+        };
+        deleteDocumentRequestTemplate: {
+            resource: string;
+            method: "DELETE";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+        createDocumentRequest: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                typeId: import("../../orm/schemas/uuid.js").Uuid | null;
+                comment: string | null;
+                collectionIds: string[];
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentRequest;
+            credentials: true;
+        };
+        updateDocumentRequest: {
+            resource: string;
+            method: "PATCH";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                typeId?: import("../../orm/types.js").Uuid | null | undefined;
+                comment?: string | null | undefined;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+        deleteDocumentRequest: {
+            resource: string;
+            method: "DELETE";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+        addDocumentToCollection: {
+            resource: string;
+            method: "PUT";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                documentId: import("../../orm/schemas/uuid.js").Uuid;
+                collectionId: import("../../orm/schemas/uuid.js").Uuid;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+        archiveDocument: {
+            resource: string;
+            method: "DELETE";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                documentId: import("../../orm/schemas/uuid.js").Uuid;
+                collectionId: import("../../orm/schemas/uuid.js").Uuid;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+        updateDocument: {
+            resource: string;
+            method: "PATCH";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                date?: import("../../orm/types.js").NumericDate | null | undefined;
+                summary?: string | null | undefined;
+                title?: string | null | undefined;
+                typeId?: import("../../orm/types.js").Uuid | null | undefined;
+                subtitle?: string | null | undefined;
+                tags?: string[] | null | undefined;
+                comment?: string | null | undefined;
+                fileId?: import("../../orm/types.js").Uuid | undefined;
+                pages?: number | null | undefined;
+                approval?: import("../models/document.model.js").DocumentApproval | undefined;
+                createUserId?: import("../../orm/types.js").Uuid | null | undefined;
+                properties?: {
+                    propertyId: import("../../orm/schemas/uuid.js").Uuid;
+                    value: string | number | boolean | null;
+                    metadata?: Partial<{
+                        attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                    }> | undefined;
+                }[] | undefined;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+    };
+};
+declare const _DocumentManagementApi: import("../../api/client/index.js").ApiClient<{
+    resource: string;
+    endpoints: {
+        loadData: {
+            resource: string;
+            method: "GET";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                collectionIds: string | string[];
+            }>;
+            result: typeof DocumentManagementData;
+            credentials: true;
+        };
+        loadDocumentRequestsTemplateData: {
+            resource: string;
+            method: "GET";
+            result: typeof DocumentRequestsTemplateData;
+            credentials: true;
+        };
+        loadAvailableCategories: {
+            resource: string;
+            method: "GET";
+            result: import("../../schema/index.js").ArraySchema<DocumentCategoryView>;
+            credentials: true;
+        };
+        loadFileContent: {
+            resource: string;
+            method: "GET";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                title: string | null;
+                id: string;
+                download?: boolean | undefined;
+            }>;
+            result: Uint8ArrayConstructor;
+            credentials: true;
+        };
+        getFileContentUrl: {
+            resource: string;
+            method: "GET";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                title: string | null;
+                id: string;
+                download?: boolean | undefined;
+            }>;
+            result: import("../../schema/index.js").StringSchema;
+            credentials: true;
+        };
+        createCategory: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                label: string;
+                parentId: import("../../orm/schemas/uuid.js").Uuid | null;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentCategory;
+            credentials: true;
+        };
+        createType: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                label: string;
+                categoryId: import("../../orm/schemas/uuid.js").Uuid;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentType;
+            credentials: true;
+        };
+        createCollection: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                parentId: import("../../orm/schemas/uuid.js").Uuid | null;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentCollection;
+            credentials: true;
+        };
+        createDocument: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                date: import("../../orm/schemas/numeric-date.js").NumericDate | null;
+                summary: string | null;
+                title: string | null;
+                typeId: import("../../orm/schemas/uuid.js").Uuid | null;
+                subtitle: string | null;
+                tags: string[] | null;
+                comment: string | null;
+                approval: import("../models/document.model.js").DocumentApproval;
+                createUserId: import("../../orm/schemas/uuid.js").Uuid | null;
+                originalFileName: string | null;
+                assignment: {
+                    collections: string | string[];
+                } | {
+                    request: string;
+                } | {
+                    automatic: {
+                        target: "request" | "collection";
+                        scope: string | string[];
+                    };
+                };
+                properties?: {
+                    propertyId: import("../../orm/schemas/uuid.js").Uuid;
+                    value: string | number | boolean | null;
+                    metadata?: Partial<{
+                        attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                    }> | undefined;
+                }[] | undefined;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            body: Uint8ArrayConstructor;
+            maxBytes: number;
+            result: typeof Document;
+            credentials: true;
+        };
+        createDocumentRequestsTemplate: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                description: string | null;
+                label: string;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentRequestsTemplate;
+            credentials: true;
+        };
+        updateDocumentRequestsTemplate: {
+            resource: string;
+            method: "PATCH";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                description?: string | null | undefined;
+                label?: string | undefined;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentRequestsTemplate;
+            credentials: true;
+        };
+        applyDocumentRequestsTemplate: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                collectionIds: string[];
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+        deleteDocumentRequestsTemplate: {
+            resource: string;
+            method: "DELETE";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+        createDocumentRequestTemplate: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                typeId: import("../../orm/schemas/uuid.js").Uuid;
+                comment: string | null;
+                requestsTemplateId: import("../../orm/schemas/uuid.js").Uuid;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentRequestTemplate;
+            credentials: true;
+        };
+        updateDocumentRequestTemplate: {
+            resource: string;
+            method: "PATCH";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                typeId?: import("../../orm/types.js").Uuid | undefined;
+                comment?: string | null | undefined;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentRequestTemplate;
+            credentials: true;
+        };
+        deleteDocumentRequestTemplate: {
+            resource: string;
+            method: "DELETE";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+        createDocumentRequest: {
+            resource: string;
+            method: "POST";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                typeId: import("../../orm/schemas/uuid.js").Uuid | null;
+                comment: string | null;
+                collectionIds: string[];
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: typeof DocumentRequest;
+            credentials: true;
+        };
+        updateDocumentRequest: {
+            resource: string;
+            method: "PATCH";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                typeId?: import("../../orm/types.js").Uuid | null | undefined;
+                comment?: string | null | undefined;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+        deleteDocumentRequest: {
+            resource: string;
+            method: "DELETE";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+        addDocumentToCollection: {
+            resource: string;
+            method: "PUT";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                documentId: import("../../orm/schemas/uuid.js").Uuid;
+                collectionId: import("../../orm/schemas/uuid.js").Uuid;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+        archiveDocument: {
+            resource: string;
+            method: "DELETE";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                documentId: import("../../orm/schemas/uuid.js").Uuid;
+                collectionId: import("../../orm/schemas/uuid.js").Uuid;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+        updateDocument: {
+            resource: string;
+            method: "PATCH";
+            parameters: import("../../schema/index.js").ObjectSchema<{
+                id: import("../../orm/types.js").IsPrimaryKey<import("../../orm/types.js").HasDefault<import("../../orm/schemas/uuid.js").Uuid>>;
+                date?: import("../../orm/types.js").NumericDate | null | undefined;
+                summary?: string | null | undefined;
+                title?: string | null | undefined;
+                typeId?: import("../../orm/types.js").Uuid | null | undefined;
+                subtitle?: string | null | undefined;
+                tags?: string[] | null | undefined;
+                comment?: string | null | undefined;
+                fileId?: import("../../orm/types.js").Uuid | undefined;
+                pages?: number | null | undefined;
+                approval?: import("../models/document.model.js").DocumentApproval | undefined;
+                createUserId?: import("../../orm/types.js").Uuid | null | undefined;
+                properties?: {
+                    propertyId: import("../../orm/schemas/uuid.js").Uuid;
+                    value: string | number | boolean | null;
+                    metadata?: Partial<{
+                        attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                    }> | undefined;
+                }[] | undefined;
+                metadata?: Partial<{
+                    attributes: import("../../orm/types.js").HasDefault<import("../../orm/schemas/json.js").Json<import("../../orm/entity.js").EntityMetadataAttributes>>;
+                }> | undefined;
+            }>;
+            result: import("../../schema/index.js").LiteralSchema<"ok">;
+            credentials: true;
+        };
+    };
+}>;
+export declare class DocumentManagementApi extends _DocumentManagementApi {
+}
+export {};

package/document-management/api/document-management.api.js

@@ -10,7 +10,7 @@ import { ReplaceClass } from '../../injector/decorators.js';
 import { array, boolean, literal, nullable, object, optional, string } from '../../schema/index.js';
 import { megabyte } from '../../utils/units.js';
 import { Document, DocumentCategory, DocumentCollection, DocumentRequest, DocumentRequestsTemplate, DocumentRequestTemplate, DocumentType } from '../models/index.js';
-import { addOrArchiveDocumentToOrFromCollectionParametersSchema, applyDocumentRequestsTemplateParametersSchema, createCollectionParametersSchema, createDocumentCategoryParametersSchema, createDocumentParametersSchema, createDocumentRequestParametersSchema, createDocumentRequestsTemplateParametersSchema, createDocumentRequestTemplateParametersSchema, createDocumentTypeParametersSchema, deleteDocumentRequestParametersSchema, deleteDocumentRequestsTemplateParametersSchema, deleteDocumentRequestTemplateParametersSchema, DocumentCategoryView, DocumentManagementData, DocumentRequestsTemplateData, loadDataParametersSchema, updateDocumentParametersSchema, updateDocumentRequestParametersSchema, updateDocumentRequestsTemplateParametersSchema, updateDocumentRequestTemplateParametersSchema } from '../models/service-models/index.js';
+import { addOrArchiveDocumentToOrFromCollectionParametersSchema, applyDocumentRequestsTemplateParametersSchema, createCollectionParametersSchema, createDocumentCategoryParametersSchema, createDocumentParametersSchema, createDocumentRequestParametersSchema, createDocumentRequestsTemplateParametersSchema, createDocumentRequestTemplateParametersSchema, createDocumentTypeParametersSchema, deleteDocumentRequestParametersSchema, deleteDocumentRequestsTemplateParametersSchema, deleteDocumentRequestTemplateParametersSchema, DocumentCategoryView, DocumentManagementData, DocumentRequestsTemplateData, loadDataParametersSchema, updateDocumentParametersSchema, updateDocumentRequestParametersSchema, updateDocumentRequestsTemplateParametersSchema, updateDocumentRequestTemplateParametersSchema } from '../service-models/index.js';
 export const documentManagementApiDefinition = defineApi({
     resource: 'document-management',
     endpoints: {

package/document-management/index.d.ts

@@ -0,0 +1,4 @@
+export * from './api/index.js';
+export * from './localizations/index.js';
+export * from './models/index.js';
+export * from './service-models/index.js';

package/document-management/index.js

@@ -1,3 +1,4 @@
 export * from './api/index.js';
 export * from './localizations/index.js';
 export * from './models/index.js';
+export * from './service-models/index.js';