Interface UserInput

Identifies user input as a document

interface UserInput {
    analyzerMetadata?: AnalyzerMetadataModel;
    annotatedAggregated?: AggregatedCaseDataModel;
    annotatedExecutionStrategy?: ExecutionStrategy;
    annotatedLineItem?: LineItemModel;
    caseId?: string;
    classificationStatus?: ClassificationStatus;
    code?: string;
    customValidationMessages?: ValidationError[];
    customerId?: string;
    documentCode?: DocumentCode;
    documentReference?: Meta<string>;
    documentStatus?: DocumentStatus;
    documentType?: DigicustDocumentType;
    extractId?: string;
    fileName?: string;
    id?: string;
    isCondensed?: boolean;
    isPseudonymized?: boolean;
    issueDate?: DateTimeModel;
    modifiedBy?: {
        date?: Date;
        displayName?: string;
        id?: string;
    };
    pageCount?: number;
    pages?: DocumentPage[];
    priority?: "beforeNormalization" | "fallback" | "afterNormalization" | "replace";
    processing?: ProcessingModel;
    projectId?: string;
    queueId?: string;
    receivedAt?: Date;
    reference?: string;
    sourceMaterialId?: string;
    subDocumentStatus?: SubDocumentStatus;
    uploadedFiles?: UploadedFileModel[];
    userDocumentStatus?: UserDocumentStatus;
    userEdited?: boolean;
}

Hierarchy (view full)

Properties

analyzerMetadata?: AnalyzerMetadataModel
annotatedAggregated?: AggregatedCaseDataModel
annotatedExecutionStrategy?: ExecutionStrategy
annotatedLineItem?: LineItemModel
caseId?: string
classificationStatus?: ClassificationStatus
code?: string
customValidationMessages?: ValidationError[]
customerId?: string
documentCode?: DocumentCode
documentReference?: Meta<string>
documentStatus?: DocumentStatus
documentType?: DigicustDocumentType
extractId?: string
fileName?: string
id?: string
isCondensed?: boolean
isPseudonymized?: boolean
issueDate?: DateTimeModel
modifiedBy?: {
    date?: Date;
    displayName?: string;
    id?: string;
}

Type declaration

  • Optional date?: Date
  • Optional displayName?: string
  • Optional id?: string
pageCount?: number
pages?: DocumentPage[]
priority?: "beforeNormalization" | "fallback" | "afterNormalization" | "replace"
processing?: ProcessingModel
projectId?: string
queueId?: string
receivedAt?: Date
reference?: string
sourceMaterialId?: string
subDocumentStatus?: SubDocumentStatus
uploadedFiles?: UploadedFileModel[]
userDocumentStatus?: UserDocumentStatus
userEdited?: boolean