@muni-sanfer/types-gestor-documental 0.0.1-beta.2 → 0.0.1-beta.21

package/dist/base/entities.d.ts

@@ -33,7 +33,7 @@ export declare const DocumentParticipantStatus: {
     Resolved: "Resolved";
     Rejected: "Rejected";
 };
-export type DocumentTrackingAction = 'Created' | 'Updated' | 'Submitted' | 'Visaed' | 'Signed' | 'Rejected' | 'Finished' | 'Discarded' | 'Numbered' | 'NumberAnnulled' | 'Annulled' | 'Delivered' | 'Derived';
+export type DocumentTrackingAction = 'Created' | 'Updated' | 'Submitted' | 'Visaed' | 'Signed' | 'Rejected' | 'Finished' | 'Discarded' | 'Numbered' | 'NumberAnnulled' | 'Annulled' | 'Delivered' | 'Derived' | 'Reassigned' | 'Dispatched' | 'DispatchReturned' | 'Received' | 'EmailCopySent' | 'EmailCopyOpened';
 export declare const DocumentTrackingAction: {
     Created: "Created";
     Updated: "Updated";
@@ -48,6 +48,34 @@ export declare const DocumentTrackingAction: {
     Annulled: "Annulled";
     Delivered: "Delivered";
     Derived: "Derived";
+    Reassigned: "Reassigned";
+    Dispatched: "Dispatched";
+    DispatchReturned: "DispatchReturned";
+    Received: "Received";
+    EmailCopySent: "EmailCopySent";
+    EmailCopyOpened: "EmailCopyOpened";
+};
+export type DocumentOrigin = 'Internal' | 'DocDigital';
+export declare const DocumentOrigin: {
+    Internal: "Internal";
+    DocDigital: "DocDigital";
+};
+export type DocumentDispatchStatus = 'Pending' | 'Dispatched' | 'Returned';
+export declare const DocumentDispatchStatus: {
+    Pending: "Pending";
+    Dispatched: "Dispatched";
+    Returned: "Returned";
+};
+export type DocDigitalInboundStatus = 'Pending' | 'Registered' | 'Returned';
+export declare const DocDigitalInboundStatus: {
+    Pending: "Pending";
+    Registered: "Registered";
+    Returned: "Returned";
+};
+export type DocumentFlowStepType = 'Employee' | 'DirectorateHead';
+export declare const DocumentFlowStepType: {
+    Employee: "Employee";
+    DirectorateHead: "DirectorateHead";
 };
 export type DocumentAttachmentType = 'File' | 'Link';
 export declare const DocumentAttachmentType: {
@@ -72,6 +100,130 @@ export declare const DocumentInstruction: {
     Respond: "Respond";
     Archive: "Archive";
 };
+export type CaseFileStatus = 'Open' | 'Closed';
+export declare const CaseFileStatus: {
+    Open: "Open";
+    Closed: "Closed";
+};
+export type CaseFileIncorporationMechanism = 'Manual' | 'WebService' | 'Mixed' | 'CitizenRepository' | 'Interoperability';
+export declare const CaseFileIncorporationMechanism: {
+    Manual: "Manual";
+    WebService: "WebService";
+    Mixed: "Mixed";
+    CitizenRepository: "CitizenRepository";
+    Interoperability: "Interoperability";
+};
+export type CaseFileActuationType = 'AdministrativeAct' | 'Notification' | 'OfficialCommunication' | 'Interoperability' | 'RequestReception' | 'Subfolder' | 'PowerRegistration';
+export declare const CaseFileActuationType: {
+    AdministrativeAct: "AdministrativeAct";
+    Notification: "Notification";
+    OfficialCommunication: "OfficialCommunication";
+    Interoperability: "Interoperability";
+    RequestReception: "RequestReception";
+    Subfolder: "Subfolder";
+    PowerRegistration: "PowerRegistration";
+};
+export type CaseFileEntryKind = 'Document' | 'File' | 'CaseFile' | 'Physical';
+export declare const CaseFileEntryKind: {
+    Document: "Document";
+    File: "File";
+    CaseFile: "CaseFile";
+    Physical: "Physical";
+};
+export type CaseFileActorRelation = 'Responsible' | 'Interested' | 'Author' | 'Referred' | 'Recipient' | 'MinisterOfFaith';
+export declare const CaseFileActorRelation: {
+    Responsible: "Responsible";
+    Interested: "Interested";
+    Author: "Author";
+    Referred: "Referred";
+    Recipient: "Recipient";
+    MinisterOfFaith: "MinisterOfFaith";
+};
+export type CaseFileActorType = 'Citizen' | 'Foreigner' | 'PrivateInstitution' | 'Official';
+export declare const CaseFileActorType: {
+    Citizen: "Citizen";
+    Foreigner: "Foreigner";
+    PrivateInstitution: "PrivateInstitution";
+    Official: "Official";
+};
+export type CaseFileTrackingAction = 'Created' | 'Updated' | 'EntryAdded' | 'EntryVoided' | 'EntryMoved' | 'ParticipantAdded' | 'ParticipantRemoved' | 'Closed' | 'Exported' | 'ShareLinkCreated' | 'ShareLinkRevoked';
+export declare const CaseFileTrackingAction: {
+    Created: "Created";
+    Updated: "Updated";
+    EntryAdded: "EntryAdded";
+    EntryVoided: "EntryVoided";
+    EntryMoved: "EntryMoved";
+    ParticipantAdded: "ParticipantAdded";
+    ParticipantRemoved: "ParticipantRemoved";
+    Closed: "Closed";
+    Exported: "Exported";
+    ShareLinkCreated: "ShareLinkCreated";
+    ShareLinkRevoked: "ShareLinkRevoked";
+};
+export type CaseFileAccessAction = 'Viewed' | 'FileDownloaded' | 'Exported';
+export declare const CaseFileAccessAction: {
+    Viewed: "Viewed";
+    FileDownloaded: "FileDownloaded";
+    Exported: "Exported";
+};
+export type ScanSessionStatus = 'Open' | 'Ready';
+export declare const ScanSessionStatus: {
+    Open: "Open";
+    Ready: "Ready";
+};
+export type TextSnippetSection = 'Vistos' | 'Considerando' | 'Resolutive' | 'Body' | 'Closing';
+export declare const TextSnippetSection: {
+    Vistos: "Vistos";
+    Considerando: "Considerando";
+    Resolutive: "Resolutive";
+    Body: "Body";
+    Closing: "Closing";
+};
+export type WorkFolderItemKind = 'Document' | 'File';
+export declare const WorkFolderItemKind: {
+    Document: "Document";
+    File: "File";
+};
+export type ServiceOutageKind = 'Unplanned' | 'Planned';
+export declare const ServiceOutageKind: {
+    Unplanned: "Unplanned";
+    Planned: "Planned";
+};
+export type QualityMetricKey = 'Effectiveness' | 'Efficiency' | 'Availability' | 'ResponseTime' | 'Accessibility' | 'FunctionalCompleteness' | 'Interoperability';
+export declare const QualityMetricKey: {
+    Effectiveness: "Effectiveness";
+    Efficiency: "Efficiency";
+    Availability: "Availability";
+    ResponseTime: "ResponseTime";
+    Accessibility: "Accessibility";
+    FunctionalCompleteness: "FunctionalCompleteness";
+    Interoperability: "Interoperability";
+};
+export type DocumentAccessAction = 'Viewed' | 'FileDownloaded' | 'TrailExported';
+export declare const DocumentAccessAction: {
+    Viewed: "Viewed";
+    FileDownloaded: "FileDownloaded";
+    TrailExported: "TrailExported";
+};
+export type AuditEntity = 'DocumentType' | 'IssuingEntity' | 'ArchivalSeries' | 'TextSnippet' | 'Holiday' | 'Procedure' | 'QualityMetric' | 'ServiceOutage';
+export declare const AuditEntity: {
+    DocumentType: "DocumentType";
+    IssuingEntity: "IssuingEntity";
+    ArchivalSeries: "ArchivalSeries";
+    TextSnippet: "TextSnippet";
+    Holiday: "Holiday";
+    Procedure: "Procedure";
+    QualityMetric: "QualityMetric";
+    ServiceOutage: "ServiceOutage";
+};
+export type AuditAction = 'Created' | 'Updated' | 'Enabled' | 'Disabled' | 'Removed';
+export declare const AuditAction: {
+    Created: "Created";
+    Updated: "Updated";
+    Enabled: "Enabled";
+    Disabled: "Disabled";
+    Removed: "Removed";
+};
 export interface DocumentTypeEntity {
     id: string;
     name: string;
@@ -81,10 +233,20 @@ export interface DocumentTypeEntity {
     nextCorrelative: number;
     correlativeYear?: number | null;
     resetsYearly: boolean;
+    numbered: boolean;
     directorateCodeReference?: number | null;
+    archivalSeries?: ArchivalSeriesEntity | null;
+    archivalSeriesId?: string | null;
+    issuingEntity?: IssuingEntityEntity | null;
+    issuingEntityId?: string | null;
+    sharesNumberingWith?: DocumentTypeEntity | null;
+    sharesNumberingWithId?: string | null;
+    numberingMembers?: DocumentTypeEntity[];
     enabled: boolean;
     documents?: DocumentEntity[];
     annulledNumbers?: DocumentAnnulledNumberEntity[];
+    flowSteps?: DocumentTypeFlowStepEntity[];
+    signatureBatches?: SignatureBatchEntity[];
     deleted: boolean;
     createdAt: string;
     updatedAt: string;
@@ -95,6 +257,7 @@ export interface DocumentEntity {
     keywords: string[];
     accessLevel: DocumentAccessLevel;
     hasSensitiveData: boolean;
+    restrictionEndsAt?: string | null;
     status: DocumentStatus;
     correlative?: number | null;
     correlativeYear?: number | null;
@@ -104,6 +267,17 @@ export interface DocumentEntity {
     annulledAt?: string | null;
     annulmentReason?: string | null;
     responseDueAt?: string | null;
+    origin: DocumentOrigin;
+    intakeNumber?: number | null;
+    intakeYear?: number | null;
+    externalFolio?: string | null;
+    externalSender?: string | null;
+    externalDate?: string | null;
+    composition?: JsonValue | null;
+    contentText?: string | null;
+    textExtractedAt?: string | null;
+    batch?: SignatureBatchEntity | null;
+    batchId?: string | null;
     replyTo?: DocumentEntity | null;
     replyToDocumentId?: string | null;
     replies?: DocumentEntity[];
@@ -125,6 +299,25 @@ export interface DocumentEntity {
     annulledNumbers?: DocumentAnnulledNumberEntity[];
     recipients?: DocumentRecipientEntity[];
     deliveries?: DocumentDeliveryEntity[];
+    caseFileEntries?: CaseFileEntryEntity[];
+    workFolderItems?: WorkFolderItemEntity[];
+    externalRecipients?: DocumentExternalRecipientEntity[];
+    emailCopies?: DocumentEmailCopyEntity[];
+    accesses?: DocumentAccessEntity[];
+    dispatch?: DocumentDispatchEntity | null;
+    docDigitalInbound?: DocDigitalInboundEntity | null;
+    deleted: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface SignatureBatchEntity {
+    id: string;
+    name: string;
+    createdByEmployeeId: string;
+    createdByFullName: string;
+    documentType?: DocumentTypeEntity;
+    documentTypeId: string;
+    documents?: DocumentEntity[];
     deleted: boolean;
     createdAt: string;
     updatedAt: string;
@@ -133,6 +326,7 @@ export interface DocumentParticipantEntity {
     id: string;
     role: DocumentParticipantRole;
     order: number;
+    stage: number;
     status: DocumentParticipantStatus;
     employeeId: string;
     fullName: string;
@@ -160,6 +354,7 @@ export interface DocumentTrackingEntity {
     id: string;
     action: DocumentTrackingAction;
     observation?: string | null;
+    sha256?: string | null;
     employeeId?: string | null;
     employeeFullName?: string | null;
     document?: DocumentEntity;
@@ -207,7 +402,418 @@ export interface DocumentDeliveryEntity {
     readAt?: string | null;
     closedAt?: string | null;
     closingNote?: string | null;
+    dueSoonRemindedAt?: string | null;
+    overdueRemindedAt?: string | null;
+    document?: DocumentEntity;
+    documentId: string;
+    createdAt: string;
+}
+export interface DocumentTypeFlowStepEntity {
+    id: string;
+    role: DocumentParticipantRole;
+    order: number;
+    type: DocumentFlowStepType;
+    employeeId?: string | null;
+    directorateCodeReference?: number | null;
+    name: string;
+    position?: string | null;
+    withPrevious: boolean;
+    documentType?: DocumentTypeEntity;
+    documentTypeId: string;
+    createdAt: string;
+}
+export interface ProcedureEntity {
+    id: string;
+    name: string;
+    cpatId?: string | null;
+    cpatCode?: string | null;
+    description?: string | null;
+    enabled: boolean;
+    caseFiles?: CaseFileEntity[];
+    deleted: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CaseFileSequenceEntity {
+    year: number;
+    next: number;
+}
+export interface CaseFileEntity {
+    id: string;
+    code: string;
+    year: number;
+    number: number;
+    title: string;
+    subject: string;
+    summary?: string | null;
+    status: CaseFileStatus;
+    accessLevel: DocumentAccessLevel;
+    hasSensitiveData: boolean;
+    restrictionEndsAt?: string | null;
+    archivalSeries?: ArchivalSeriesEntity | null;
+    archivalSeriesId?: string | null;
+    incorporationMechanism: CaseFileIncorporationMechanism;
+    schemaVersion: string;
+    procedure?: ProcedureEntity;
+    procedureId: string;
+    responsibleEmployeeId: string;
+    responsibleFullName: string;
+    responsiblePosition?: string | null;
+    closedAt?: string | null;
+    closedByEmployeeId?: string | null;
+    closedByFullName?: string | null;
+    closingNote?: string | null;
+    participants?: CaseFileParticipantEntity[];
+    actors?: CaseFileActorEntity[];
+    entries?: CaseFileEntryEntity[];
+    linkedFrom?: CaseFileEntryEntity[];
+    trackings?: CaseFileTrackingEntity[];
+    metadataChanges?: CaseFileMetadataChangeEntity[];
+    accesses?: CaseFileAccessEntity[];
+    shareLinks?: CaseFileShareLinkEntity[];
+    createdAt: string;
+    updatedAt: string;
+    workFolder?: WorkFolderEntity | null;
+}
+export interface CaseFileParticipantEntity {
+    id: string;
+    employeeId: string;
+    fullName: string;
+    position?: string | null;
+    addedByEmployeeId: string;
+    addedByFullName: string;
+    caseFile?: CaseFileEntity;
+    caseFileId: string;
+    createdAt: string;
+}
+export interface CaseFileActorEntity {
+    id: string;
+    relation: CaseFileActorRelation;
+    actorType: CaseFileActorType;
+    identifier?: string | null;
+    name: string;
+    caseFile?: CaseFileEntity;
+    caseFileId: string;
+    createdAt: string;
+}
+export interface CaseFileEntryEntity {
+    id: string;
+    sequence: number;
+    kind: CaseFileEntryKind;
+    actuationType: CaseFileActuationType;
+    title: string;
+    folder?: string | null;
+    document?: DocumentEntity | null;
+    documentId?: string | null;
+    fileId?: string | null;
+    fileName?: string | null;
+    documentTypeName?: string | null;
+    originDate?: string | null;
+    author?: string | null;
+    keywords: string[];
+    accessLevel?: DocumentAccessLevel | null;
+    hasSensitiveData?: boolean | null;
+    physicalLocation?: string | null;
+    physicalReason?: string | null;
+    pageCount?: number | null;
+    linkedCaseFile?: CaseFileEntity | null;
+    linkedCaseFileId?: string | null;
+    sha256?: string | null;
+    size?: number | null;
+    hasAdvancedSignature: boolean;
+    signatureCheck?: JsonValue | null;
+    incorporatedByEmployeeId: string;
+    incorporatedByFullName: string;
+    voidedAt?: string | null;
+    voidedByEmployeeId?: string | null;
+    voidedByFullName?: string | null;
+    voidReason?: string | null;
+    caseFile?: CaseFileEntity;
+    caseFileId: string;
+    createdAt: string;
+}
+export interface CaseFileTrackingEntity {
+    id: string;
+    action: CaseFileTrackingAction;
+    observation?: string | null;
+    employeeId?: string | null;
+    employeeFullName?: string | null;
+    caseFile?: CaseFileEntity;
+    caseFileId: string;
+    createdAt: string;
+}
+export interface CaseFileMetadataChangeEntity {
+    id: string;
+    field: string;
+    previousValue?: string | null;
+    newValue?: string | null;
+    employeeId: string;
+    employeeFullName: string;
+    caseFile?: CaseFileEntity;
+    caseFileId: string;
+    createdAt: string;
+}
+export interface CaseFileAccessEntity {
+    id: string;
+    action: CaseFileAccessAction;
+    entryId?: string | null;
+    employeeId?: string | null;
+    employeeFullName: string;
+    shareLink?: CaseFileShareLinkEntity | null;
+    shareLinkId?: string | null;
+    caseFile?: CaseFileEntity;
+    caseFileId: string;
+    createdAt: string;
+}
+export interface CaseFileShareLinkEntity {
+    id: string;
+    tokenHash: string;
+    recipient: string;
+    recipientEmail?: string | null;
+    purpose?: string | null;
+    allowExport: boolean;
+    expiresAt: string;
+    createdByEmployeeId: string;
+    createdByFullName: string;
+    revokedAt?: string | null;
+    revokedByEmployeeId?: string | null;
+    revokedByFullName?: string | null;
+    caseFile?: CaseFileEntity;
+    caseFileId: string;
+    accesses?: CaseFileAccessEntity[];
+    createdAt: string;
+}
+export interface DocumentEmailCopyEntity {
+    id: string;
+    name: string;
+    email: string;
+    tokenHash?: string | null;
+    expiresAt?: string | null;
+    issuedAt?: string | null;
+    openedAt?: string | null;
+    downloadCount: number;
+    document?: DocumentEntity;
+    documentId: string;
+    createdAt: string;
+}
+export interface ScanSessionEntity {
+    id: string;
+    tokenHash: string;
+    status: ScanSessionStatus;
+    employeeId: string;
+    pages: JsonValue;
+    fileId?: string | null;
+    fileName?: string | null;
+    expiresAt: string;
+    finishedAt?: string | null;
+    createdAt: string;
+}
+export interface DocumentExternalRecipientEntity {
+    id: string;
+    entityId: number;
+    entityName: string;
+    userId?: number | null;
+    userName?: string | null;
+    userPosition?: string | null;
+    document?: DocumentEntity;
+    documentId: string;
+    createdAt: string;
+}
+export interface DocumentDispatchEntity {
+    id: string;
+    status: DocumentDispatchStatus;
+    folio?: string | null;
+    docDigitalTypeId?: number | null;
+    docDigitalTypeName?: string | null;
+    docDigitalDocumentId?: string | null;
+    docDigitalRequestId?: string | null;
+    dispatchedAt?: string | null;
+    dispatchedByEmployeeId?: string | null;
+    dispatchedByFullName?: string | null;
+    returnedAt?: string | null;
+    returnedByEmployeeId?: string | null;
+    returnedByFullName?: string | null;
+    returnReason?: string | null;
+    document?: DocumentEntity;
+    documentId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface DocDigitalInboundEntity {
+    id: string;
+    docDigitalDocumentId: string;
+    docDigitalRequestId?: string | null;
+    status: DocDigitalInboundStatus;
+    subject: string;
+    description?: string | null;
+    folio?: string | null;
+    folioDate?: string | null;
+    typeName?: string | null;
+    reserved: boolean;
+    senderEntityId?: number | null;
+    senderEntityName?: string | null;
+    senderName?: string | null;
+    senderPosition?: string | null;
+    recipientEntityId?: number | null;
+    recipientEntityName?: string | null;
+    fileId?: string | null;
+    fileName?: string | null;
+    attachments: JsonValue;
+    signatureCheck?: JsonValue | null;
+    registeredAt?: string | null;
+    registeredByEmployeeId?: string | null;
+    registeredByFullName?: string | null;
+    acknowledgedAt?: string | null;
+    acknowledgeError?: string | null;
+    returnedAt?: string | null;
+    returnedByEmployeeId?: string | null;
+    returnedByFullName?: string | null;
+    returnReason?: string | null;
+    document?: DocumentEntity | null;
+    documentId?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface HolidayEntity {
+    id: string;
+    date: string;
+    name: string;
+    createdAt: string;
+}
+export interface TextSnippetEntity {
+    id: string;
+    title: string;
+    text: string;
+    section: TextSnippetSection;
+    keywords: string[];
+    enabled: boolean;
+    deleted: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ArchivalSeriesEntity {
+    id: string;
+    code: string;
+    name: string;
+    section?: string | null;
+    description?: string | null;
+    enabled: boolean;
+    documentTypes?: DocumentTypeEntity[];
+    caseFiles?: CaseFileEntity[];
+    deleted: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface IssuingEntityEntity {
+    id: string;
+    name: string;
+    shortName?: string | null;
+    directorateCodeReferences: number[];
+    docDigitalEntityId?: number | null;
+    enabled: boolean;
+    documentTypes?: DocumentTypeEntity[];
+    deleted: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface IntakeSequenceEntity {
+    year: number;
+    next: number;
+}
+export interface WorkFolderEntity {
+    id: string;
+    name: string;
+    description?: string | null;
+    ownerEmployeeId: string;
+    ownerFullName: string;
+    caseFile?: CaseFileEntity | null;
+    caseFileId?: string | null;
+    participants?: WorkFolderParticipantEntity[];
+    items?: WorkFolderItemEntity[];
+    deleted: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface WorkFolderParticipantEntity {
+    id: string;
+    employeeId: string;
+    fullName: string;
+    folder?: WorkFolderEntity;
+    folderId: string;
+    createdAt: string;
+}
+export interface WorkFolderItemEntity {
+    id: string;
+    kind: WorkFolderItemKind;
+    title: string;
+    document?: DocumentEntity | null;
+    documentId?: string | null;
+    fileId?: string | null;
+    fileName?: string | null;
+    addedByEmployeeId: string;
+    addedByFullName: string;
+    folder?: WorkFolderEntity;
+    folderId: string;
+    createdAt: string;
+}
+export interface ServiceOutageEntity {
+    id: string;
+    kind: ServiceOutageKind;
+    startedAt: string;
+    endedAt?: string | null;
+    cause: string;
+    affectedServices?: string | null;
+    createdByEmployeeId: string;
+    createdByFullName: string;
+    updatedByFullName?: string | null;
+    deleted: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface QualityMetricSettingEntity {
+    key: QualityMetricKey;
+    threshold: number;
+    declaredValue?: number | null;
+    declaredNote?: string | null;
+    declaredAt?: string | null;
+    declaredByFullName?: string | null;
+    updatedAt: string;
+}
+export interface ServiceTimingEntity {
+    hour: string;
+    count: number;
+    errorCount: number;
+    totalMs: number;
+    maxMs: number;
+    under100: number;
+    under250: number;
+    under500: number;
+    under1000: number;
+    under2000: number;
+    under5000: number;
+    over5000: number;
+}
+export interface DocumentAccessEntity {
+    id: string;
+    action: DocumentAccessAction;
+    employeeId?: string | null;
+    employeeFullName: string;
     document?: DocumentEntity;
     documentId: string;
     createdAt: string;
 }
+export interface AuditLogEntity {
+    id: string;
+    entity: AuditEntity;
+    action: AuditAction;
+    entityId?: string | null;
+    name: string;
+    details?: JsonValue | null;
+    employeeId?: string | null;
+    employeeFullName: string;
+    createdAt: string;
+}
+type JsonValue = string | number | boolean | {
+    [key in string]?: JsonValue;
+} | Array<JsonValue> | null;
+export {};