Опис обʼєктів для методів сервісу EDIN-IDP

Обʼєкт IDPTasksQuery

export type IDPTasksQuery = {
    uuid?: string; // uuid завдання
    date?: DateTimeRange; // обʼєкт DateTimeRange
    fileName?: string; // назва файла
    limit?: Limitation; // обʼєкт Limitation
    status?: IDPTaskStatus[]; // масив обʼєктів IDPTaskStatus
    source?: IDPTaskSource[]; // масив обʼєктів IDPTaskSource
}

Обʼєкт IDPTask

export type IDPTask = {
    id: number; // ід задачі
    userId: number; // ід користувача
    uuid: string; // uuid задачі
    status: IDPTaskStatus; // обʼєкт IDPTaskStatus
    date: number; // дата завантаження файла у форматі UnixTimeStamp
    doneDate: number; // дата завершення розпізнавання
    info: IDPTaskInfo; // обʼєкт IDPTaskInfo
    docType: IDPDocType; // обʼєкт IDPDocType
}

Обʼєкт IDPTaskStatus

export type IDPTaskStatus = "ERROR" | "CREATED" | "PROCESSING" | "DONE" | "VERIFIED" | "PROCESSED";

Обʼєкт IDPTaskSource

export type IDPTaskSource = "API" | "WEB";

Обʼєкт DateTimeRange

export type DateTimeRange = {
    startTimestamp?: number; // дата початку періоду у форматі UnixTimeStamp
    finishTimestamp?: number; // дата завершення періоду у форматі UnixTimeStamp
    excludeZero?: boolean; // виключити пусті дати
}

Обʼєкт Limitation

export type Limitation = {
    offset?: number; // початкова позиція
    count?: number; // к-сть файлів у відображенні (не більше 100)
}

Обʼєкт IDPTaskInfo

export type IDPTaskInfo = {
    source: IDPTaskSource; // обʼєкт IDPTaskSource
    mimeType: string; // тип файла
    fileName: string; // назва файла
}

Обʼєкт IDPDocType

export type IDPDocType = {
    docTypeId: number; // ід типу документа
    docTypeAlias: string; // псевдонім типу документа
    docType: string; // назва типу документа
}