red-ui/libs/red-ui-http/src/lib/model/file.ts

/**
 * API Documentation for Redaction Gateway
 * Description for redaction
 *
 * OpenAPI spec version: 1.0
 *
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { FileAttributes } from "./fileAttributes";

/**
 * Object containing information on a specific file.
 */
export interface IFile {
    /**
     * Date and time when the file was added to the system.
     */
    readonly added?: string;
    /**
     * Shows if all manual changes have been applied by a reanalysis.
     */
    readonly allManualRedactionsApplied?: boolean;
    /**
     * Shows how long the last analysis took
     */
    readonly analysisDuration?: number;
    /**
     * Shows if the file requires reanalysis.
     */
    readonly analysisRequired?: boolean;
    /**
     * Shows the date of approval, if approved.
     */
    readonly approvalDate?: string;
    /**
     * The current reviewer's (if any) user id.
     */
    readonly currentReviewer?: string;
    /**
     * Shows which dictionary versions was used during the analysis.
     */
    readonly dictionaryVersion?: number;
    /**
     * Shows which dossier dictionary versions was used during the analysis.
     */
    readonly dossierDictionaryVersion?: number;
    /**
     * The ID of the dossier the file belongs to.
     */
    readonly dossierId: string;
    /**
     * Shows if the file was excluded from analysis.
     */
    readonly excluded?: boolean;
    /**
     * Set of excluded pages for this file.
     */
    readonly excludedPages?: Array<number>;
    fileAttributes?: FileAttributes;
    /**
     * The ID of the file.
     */
    readonly fileId: string;
    /**
     * The file's name.
     */
    readonly filename: string;
    /**
     * Shows if this file has comments on annotations.
     */
    readonly hasAnnotationComments?: boolean;
    /**
     * Shows if any hints were found during the analysis.
     */
    readonly hasHints?: boolean;
    /**
     * Shows if any images were found during the analysis.
     */
    readonly hasImages?: boolean;
    /**
     * Shows if any redactions were found during the analysis.
     */
    readonly hasRedactions?: boolean;
    /**
     * Shows if any requests were found during the analysis.
     */
    readonly hasRequests?: boolean;
    /**
     * Shows if there are any Suggestions in this file.
     */
    readonly hasSuggestions?: boolean;
    /**
     * Shows if there is any change between the previous and current analysis.
     */
    readonly hasUpdates?: boolean;
    /**
     * Date and time when the files attributes was last updated.
     */
    readonly lastFileAttributeChange?: string;
    /**
     * Shows if this file has been OCRed by us. Last Time of OCR.
     */
    readonly lastOCRTime?: string;
    /**
     * Shows the last date of a successful analysis.
     */
    readonly lastProcessed?: string;
    /**
     * The last reviewer's (if any) user id.
     */
    readonly lastReviewer?: string;
    /**
     * Date and time when the file was last updated.
     */
    readonly lastUpdated?: string;
    /**
     * Shows last date the document was uploaded.
     */
    readonly lastUploaded?: string;
    /**
     * Shows which legal basis versions was used during the analysis.
     */
    readonly legalBasisVersion?: number;
    /**
     * The number of times the file has been analyzed.
     */
    readonly numberOfAnalyses?: number;
    /**
     * The number of pages of the file.
     */
    readonly numberOfPages?: number;
    /**
     * Shows which rules versions was used during the analysis.
     */
    readonly rulesVersion?: number;
    /**
     * Shows if the file is soft deleted.
     */
    readonly softDeleted?: string;
    /**
     * The status of the file with regard to its analysis an review processes.
     */
    readonly status: FileStatus;
    /**
     * The ID of the user who uploaded the file.
     */
    readonly uploader?: string;
}

export const FileStatuses = {
    APPROVED: 'APPROVED',
    DELETED: 'DELETED',
    ERROR: 'ERROR',
    EXCLUDED: 'EXCLUDED',
    FULLREPROCESS: 'FULLREPROCESS',
    INDEXING: 'INDEXING',
    OCR_PROCESSING: 'OCR_PROCESSING',
    PROCESSING: 'PROCESSING',
    REPROCESS: 'REPROCESS',
    UNASSIGNED: 'UNASSIGNED',
    UNDER_APPROVAL: 'UNDER_APPROVAL',
    UNDER_REVIEW: 'UNDER_REVIEW',
    UNPROCESSED: 'UNPROCESSED'
} as const;

export type FileStatus = keyof typeof FileStatuses;