digicust_types 1.7.281 → 1.7.282

package/lib/models/digicust/digicust-document-type.enum.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DigicustDocumentType = void 0;
-/**
- * Identifies different document types
- */
-var DigicustDocumentType;
-(function (DigicustDocumentType) {
-    DigicustDocumentType["Invoice"] = "invoice";
-    DigicustDocumentType["Waybill"] = "waybill";
-    DigicustDocumentType["PackingList"] = "packingList";
-    DigicustDocumentType["TaxInvoice"] = "taxInvoice";
-    DigicustDocumentType["CustomDocument"] = "customDocument";
-    DigicustDocumentType["ItemListing"] = "itemListing";
-    DigicustDocumentType["CostOverview"] = "costOverview";
-    DigicustDocumentType["DeclarationOfOrigin"] = "declarationOfOrigin";
-    DigicustDocumentType["PreferentialProofOfOrigin"] = "preferentialProofOfOrigin";
-    DigicustDocumentType["ProofOfDirectTransport"] = "proofOfDirectTransport";
-})(DigicustDocumentType = exports.DigicustDocumentType || (exports.DigicustDocumentType = {}));

package/lib/models/digicust/digicust-document.model.d.ts

@@ -1,45 +0,0 @@
-import { ClassificationStatus, DigicustDocumentType, DocumentCode, DocumentStatus, SubDocumentStatus, UserDocumentStatus } from ".";
-import { DateTimeModel, RossumImportStatus } from "..";
-import { AnalyzerMetadataModel } from "./AnalyzerMetadataModel.model";
-import { ProcessingModel } from "./extractions/extraction.model";
-/**
- * Base model for different types of documents (e.g. waybills, invoices, ...)
- */
-export interface DigicustDocumentModel {
-    id?: string;
-    queueId?: string;
-    caseId?: string;
-    projectId?: string;
-    customerId?: string;
-    extractId?: string;
-    fileName?: string;
-    documentType?: DigicustDocumentType;
-    documentCode?: DocumentCode;
-    documentStatus?: DocumentStatus;
-    userDocumentStatus?: UserDocumentStatus;
-    subDocumentStatus?: SubDocumentStatus;
-    classificationStatus?: ClassificationStatus;
-    processing?: ProcessingModel;
-    receivedAt?: Date;
-    code?: string;
-    reference?: string;
-    issueDate?: DateTimeModel;
-    isCondensed?: boolean;
-    [customField: string]: any;
-    analyzerMetadata?: AnalyzerMetadataModel;
-    modifiedBy?: {
-        id?: String;
-        displayName?: String;
-        date?: Date;
-    };
-    /**
-     * @deprecated
-     */
-    rossumMetadata?: {
-        importStatus?: RossumImportStatus;
-        annotationId?: string;
-        queueId?: number;
-        exportOnConfirmed?: boolean;
-    };
-}
-export declare const condenseDocument: (document?: DigicustDocumentModel | undefined) => DigicustDocumentModel | null;

package/lib/models/digicust/digicust-document.model.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.condenseDocument = void 0;
-var _1 = require(".");
-var condenseDocument = function (document) {
-    var doc = document
-        ? {
-            id: document.id,
-            caseId: document.caseId,
-            queueId: document.queueId,
-            fileName: document.fileName,
-            documentType: document.documentType,
-            documentStatus: document.documentStatus,
-            userDocumentStatus: document.UserDocumentStatus,
-            subDocumentStatus: document.SubDocumentStatus,
-            classificationStatus: document.classificationStatus,
-            code: document.code,
-            reference: document.reference,
-            issueDate: document.issueDate,
-            analyzerMetadata: document.analyzerMetadata,
-            isCondensed: true,
-        }
-        : null;
-    if ((doc === null || doc === void 0 ? void 0 : doc.documentType) === _1.DigicustDocumentType.Invoice) {
-        var invoice = doc;
-        if (invoice.items) {
-            invoice.items = invoice.items.map(function (item) {
-                var lineItem = (0, _1.condenseLineItem)(item);
-                if (!lineItem) {
-                    return {};
-                }
-                return lineItem;
-            });
-        }
-    }
-    return doc;
-};
-exports.condenseDocument = condenseDocument;

package/lib/models/digicust/document-code.model.d.ts

@@ -1,12 +0,0 @@
-import { Meta } from "../common";
-import { DigicustDocumentType } from "./digicust-document-type.enum";
-/**
- * Coding of documents
- */
-export interface DocumentCode extends Meta<DigicustDocumentType> {
-    NC_24000?: string;
-    Dokumentenarten?: string;
-    DE_I0200?: string;
-    /** Bescheinigungsbereich */
-    DE_I0200_Bereich?: string;
-}

package/lib/models/digicust/document-code.model.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/digicust/document-status.enum.d.ts

@@ -1,38 +0,0 @@
-/**
- * Document Status for case document divided based on the usage
- */
-export declare enum DocumentStatus {
-    Initial = "initial",
-    Processing = "processing",
-    UserClassifying = "user-classifying",
-    Extracting = "extracting",
-    UserExtracting = "user-extracting",
-    Error = "error",
-    Finished = "finished",
-    Review = "review"
-}
-export declare enum UserDocumentStatus {
-    Aborted = "aborted",
-    Postponed = "postponed",
-    Confirmed = "confirmed",
-    Deleted = "deleted",
-    Rejected = "rejected",
-    Exported = "exported",
-    Testing = "testing",
-    Validate = "validate"
-}
-export declare enum SubDocumentStatus {
-    manual = "manual",
-    inProgress = "In Progress",
-    completed = "completed",
-    failed = "failed"
-}
-export declare enum ClassificationStatus {
-    Edit = "edit",
-    OnHold = "onhold",
-    Edited = "edited",
-    Refused = "refused",
-    Finished = "finished",
-    Erased = "erased",
-    OtherDocs = "otherdocs"
-}

package/lib/models/digicust/document-status.enum.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClassificationStatus = exports.SubDocumentStatus = exports.UserDocumentStatus = exports.DocumentStatus = void 0;
-/**
- * Document Status for case document divided based on the usage
- */
-var DocumentStatus;
-(function (DocumentStatus) {
-    DocumentStatus["Initial"] = "initial";
-    DocumentStatus["Processing"] = "processing";
-    DocumentStatus["UserClassifying"] = "user-classifying";
-    DocumentStatus["Extracting"] = "extracting";
-    DocumentStatus["UserExtracting"] = "user-extracting";
-    DocumentStatus["Error"] = "error";
-    DocumentStatus["Finished"] = "finished";
-    DocumentStatus["Review"] = "review";
-})(DocumentStatus = exports.DocumentStatus || (exports.DocumentStatus = {}));
-var UserDocumentStatus;
-(function (UserDocumentStatus) {
-    UserDocumentStatus["Aborted"] = "aborted";
-    UserDocumentStatus["Postponed"] = "postponed";
-    UserDocumentStatus["Confirmed"] = "confirmed";
-    UserDocumentStatus["Deleted"] = "deleted";
-    UserDocumentStatus["Rejected"] = "rejected";
-    UserDocumentStatus["Exported"] = "exported";
-    UserDocumentStatus["Testing"] = "testing";
-    UserDocumentStatus["Validate"] = "validate";
-})(UserDocumentStatus = exports.UserDocumentStatus || (exports.UserDocumentStatus = {}));
-var SubDocumentStatus;
-(function (SubDocumentStatus) {
-    SubDocumentStatus["manual"] = "manual";
-    SubDocumentStatus["inProgress"] = "In Progress";
-    SubDocumentStatus["completed"] = "completed";
-    SubDocumentStatus["failed"] = "failed";
-})(SubDocumentStatus = exports.SubDocumentStatus || (exports.SubDocumentStatus = {}));
-var ClassificationStatus;
-(function (ClassificationStatus) {
-    ClassificationStatus["Edit"] = "edit";
-    ClassificationStatus["OnHold"] = "onhold";
-    ClassificationStatus["Edited"] = "edited";
-    ClassificationStatus["Refused"] = "refused";
-    ClassificationStatus["Finished"] = "finished";
-    ClassificationStatus["Erased"] = "erased";
-    ClassificationStatus["OtherDocs"] = "otherdocs";
-})(ClassificationStatus = exports.ClassificationStatus || (exports.ClassificationStatus = {}));

package/lib/models/digicust/documents/invoice-language.enum.d.ts

@@ -1,13 +0,0 @@
-/**
- * Invoice Languages Enum
- */
-export declare enum InvoiceLanguage {
-    EN = "eng",
-    DE = "deu",
-    TR = "t\u00FCrk",
-    FR = "french",
-    SP = "spanish",
-    SK = "slowakian",
-    HU = "hungarian",
-    IT = "italian"
-}

package/lib/models/digicust/documents/invoice-language.enum.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvoiceLanguage = void 0;
-/**
- * Invoice Languages Enum
- */
-var InvoiceLanguage;
-(function (InvoiceLanguage) {
-    InvoiceLanguage["EN"] = "eng";
-    InvoiceLanguage["DE"] = "deu";
-    InvoiceLanguage["TR"] = "t\u00FCrk";
-    InvoiceLanguage["FR"] = "french";
-    InvoiceLanguage["SP"] = "spanish";
-    InvoiceLanguage["SK"] = "slowakian";
-    InvoiceLanguage["HU"] = "hungarian";
-    InvoiceLanguage["IT"] = "italian";
-})(InvoiceLanguage = exports.InvoiceLanguage || (exports.InvoiceLanguage = {}));

package/lib/models/digicust/eori.model.d.ts

@@ -1,8 +0,0 @@
-import { Meta } from "../common";
-/** EORI number */
-export interface EORI extends Meta<string> {
-    value?: string;
-    /** alpha2code */
-    nationality?: string;
-    valid?: boolean;
-}

package/lib/models/digicust/eori.model.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/digicust/event.model.d.ts

@@ -1,64 +0,0 @@
-/**
- * Base model of an event (e.g. webhook or email)
- */
-export interface Event {
-    checkpoint?: string;
-    suppressMultipleExecutions?: boolean;
-    type?: EventType;
-}
-export declare enum EventType {
-    webhook = "webhook",
-    mail = "email",
-    sftp = "sftp",
-    mountedSFTP = "mountedSFTP"
-}
-export interface WebhookEvent extends Event {
-    type: EventType.webhook;
-    url?: string;
-    method?: "get" | "post" | "patch" | "delete" | "put";
-    body?: any;
-    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
-    bodyMapping?: string;
-    contentType?: string;
-}
-export interface SFTPEvent extends Event {
-    type: EventType.sftp;
-    /** How to map the data */
-    caseFileMapping: CaseFileMapping;
-    "sftp-password": string;
-    "sftp-login-name": string;
-    "sftp-port": string;
-    "sftp-dns-name": string;
-    "sftp-path": string;
-}
-export interface EmailEvent extends Event {
-    type: EventType.mail;
-    emailAddress?: string;
-    title?: string;
-    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
-    titleMapping?: string;
-    body?: any;
-    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
-    bodyMapping?: string;
-    attachDocuments?: {
-        active?: boolean;
-        /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
-        fileNameMapping?: string;
-    };
-    attachCase?: {
-        active?: boolean;
-    } & CaseFileMapping;
-}
-export interface CaseFileMapping {
-    format?: "JSON" | "CSV" | "XML" | "TXT";
-    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
-    fileNameMapping?: string;
-    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
-    mapping?: string;
-    /** Delimiter for CSV mapping */
-    csvSeparator?: string;
-    /** Include headers in CSV */
-    includeHeaders?: boolean;
-    /** Remove non-latin symbols */
-    removeAccents?: boolean;
-}

package/lib/models/digicust/event.model.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventType = void 0;
-var EventType;
-(function (EventType) {
-    EventType["webhook"] = "webhook";
-    EventType["mail"] = "email";
-    EventType["sftp"] = "sftp";
-    EventType["mountedSFTP"] = "mountedSFTP";
-})(EventType = exports.EventType || (exports.EventType = {}));

package/lib/models/digicust/execution-strategy.model.d.ts

@@ -1,105 +0,0 @@
-import { DigicustDocumentType } from ".";
-import { Event } from "./event.model";
-import { ProcedureMode } from "./procedure.model";
-/**
- * Execution strategies are customer-configurable plans on how to process a specific case.
- */
-export interface ExecutionStrategy {
-    id?: string;
-    alias?: string;
-    moduleId?: string;
-    customerId?: string;
-    projectId?: string;
-    isCondensed?: boolean;
-    subscriptionId?: string;
-    procedureCode?: string;
-    importViaSFTP?: {
-        active?: boolean;
-        "sftp-password"?: string;
-        "sftp-login-name"?: string;
-        "sftp-port"?: string;
-        "sftp-dns-name"?: string;
-        "sftp-inbound"?: string;
-        "sftp-outbound"?: string;
-    };
-    whitelistedImportEmails?: string[];
-    defaultClassification?: DigicustDocumentType;
-    defaultProcedureMode?: ProcedureMode;
-    dataExtraction?: {
-        active?: boolean;
-        exportOnConfirmedStrategy?: boolean;
-        queueMapping?: {
-            documentType: DigicustDocumentType;
-            queueId: string;
-        }[];
-        classification?: {
-            /** Defines whether a classification shall be assumed correct
-             * if a specific confidence level is reached */
-            automateOnMinConfidence?: boolean;
-            /** Value between 1 (very confident) to 0 (no confidence) */
-            automateMinConfidence?: number;
-        };
-        /**
-         * @deprecated
-         */
-        rossumExportOnConfirmed?: boolean;
-        /** for rossum */
-        overrideQueues?: {
-            documentType: string;
-            queue: number;
-        }[];
-    };
-    dataNormalization?: {
-        active?: boolean;
-        /** Determines how to deal with additional costs like shipping costs, packing, ... */
-        additionalCostsStrategy?: "addToFirstItem" | "splitToAllItems";
-        allowDateInOrderNumber?: boolean;
-    };
-    dataValidation?: {
-        active?: boolean;
-    };
-    hsClassification?: {
-        active?: boolean;
-        research?: boolean;
-    };
-    /** @deprecated */
-    dakosySubmission?: {
-        active?: boolean;
-    };
-    dataIntegration?: {
-        active?: boolean;
-    };
-    pseudonymization?: {
-        active?: boolean;
-        interval?: number;
-        time?: number;
-    };
-    isProcessWithDextor: boolean;
-    submission?: {
-        active?: boolean;
-        vendor?: "dakosy";
-        config?: {
-            "sftp-password"?: string;
-            "sftp-login-name"?: string;
-            "sftp-port"?: string;
-            "sftp-dns-name"?: string;
-            "sftp-inbound"?: string;
-            "sftp-outbound"?: string;
-            "partner-id"?: string;
-        };
-    } | {
-        active?: boolean;
-        vendor?: "aeb";
-        config?: {
-            "client-name"?: string;
-            "user-name"?: string;
-            password?: string;
-            endpoint?: string;
-            "client-system-id"?: string;
-            "client-ident-code"?: string;
-        };
-    };
-    events: Event[];
-    automated?: boolean;
-}
-export declare const condenseExecutionStrategy: (strategy?: ExecutionStrategy | undefined) => ExecutionStrategy | null;

package/lib/models/digicust/execution-strategy.model.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.condenseExecutionStrategy = void 0;
-var condenseExecutionStrategy = function (strategy) { return (strategy
-    ? {
-        id: strategy.id,
-        alias: strategy.alias,
-        customerId: strategy.customerId,
-        subscriptionId: strategy.subscriptionId,
-        isCondensed: true,
-    }
-    : null); };
-exports.condenseExecutionStrategy = condenseExecutionStrategy;

package/lib/models/digicust/extractions/extraction-grid.model.d.ts

@@ -1,22 +0,0 @@
-import { Bbox } from "../../common/bbox.model";
-import { ExtractionField } from ".";
-export interface ExtractionGrid {
-    id?: string;
-    label?: string;
-    bbox?: Bbox;
-    pageId?: string;
-    columns?: ExtractionGridColumn[];
-    items?: ExtractionGridItem[];
-    /** Groups multiple grids that belong together */
-    gridGroupId?: string;
-}
-export interface ExtractionGridItem {
-    id?: string;
-    fields?: ExtractionField[];
-    bbox?: Bbox;
-}
-export interface ExtractionGridColumn {
-    id?: string;
-    label?: string;
-    bbox?: Bbox;
-}

package/lib/models/digicust/extractions/extraction-grid.model.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/digicust/extractions/extraction.model.d.ts

@@ -1,65 +0,0 @@
-import { Bbox } from "../../common/bbox.model";
-import { ExtractionGrid } from ".";
-/**
- * Output of the data extraction
- */
-export interface Extraction {
-    id?: string;
-    customerId?: string;
-    projectId?: string;
-    caseId?: string;
-    documentId?: string;
-    pages?: ExtractionPage[];
-    groups?: ExtractionGroup[];
-    grids?: ExtractionGrid[];
-    errors?: Array<Error>;
-    originalFileName?: string;
-    fileName?: string;
-    documentType?: string;
-    documentStatus?: string;
-    userDocumentStatus?: string;
-    subDocumentStatus?: string;
-    receivedAt?: string;
-    code?: string;
-    reference?: string;
-    issueDate?: string;
-    isCondensed?: boolean;
-    processing?: ProcessingModel;
-    analyzerMetadata?: {
-        importStatus?: string;
-        annotationId?: string;
-        queueId?: string;
-        exportOnConfirmed?: boolean;
-    };
-    queueId?: string;
-    isLoading?: boolean;
-}
-export interface ProcessingModel {
-    status?: "done" | "inprocess" | "error";
-    percentage?: number;
-    date?: Date;
-    errorMessage?: string;
-}
-export interface ExtractionGroup {
-    id?: string;
-    label?: string;
-    fields?: ExtractionField[];
-}
-export interface ExtractionField {
-    id?: string;
-    label?: string;
-    confidence?: number;
-    value?: string;
-    bbox?: Bbox;
-    pageId?: string;
-    name?: string;
-    active?: boolean;
-    dataType?: string;
-}
-export interface ExtractionPage {
-    id?: string;
-    width?: number;
-    height?: number;
-    /** label of classification */
-    label?: string;
-}

package/lib/models/digicust/extractions/extraction.model.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/digicust/extractions/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./extraction.model";
-export * from "./extraction-grid.model";

package/lib/models/digicust/extractions/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./extraction.model"), exports);
-__exportStar(require("./extraction-grid.model"), exports);

package/lib/models/digicust/frontend-big-section.model.d.ts

@@ -1,13 +0,0 @@
-import { DigicustDocumentType } from ".";
-import { FrontendSmallSection } from "./frontend-small-section.mode";
-export interface FrontendBigSection {
-    title: String;
-    icon: String;
-    documentType?: DigicustDocumentType;
-    subInfo: Array<{
-        title: String;
-        boxes: Array<String>;
-    }>;
-    sections: Array<FrontendSmallSection>;
-    pagination: Boolean;
-}

package/lib/models/digicust/frontend-big-section.model.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/digicust/frontend-group.model.d.ts

@@ -1,6 +0,0 @@
-import { FrontendFields } from "../common/frontend-fields.model";
-export interface FrontendGroup {
-    title: String;
-    fields?: Array<FrontendFields>;
-    icon?: String;
-}

package/lib/models/digicust/frontend-group.model.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/digicust/frontend-mapping.model.d.ts

@@ -1,4 +0,0 @@
-import { FrontendBigSection } from "./frontend-big-section.model";
-export interface FrontendMapping {
-    bigSection: Array<FrontendBigSection>;
-}

package/lib/models/digicust/frontend-mapping.model.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/digicust/frontend-small-section.mode.d.ts

@@ -1,13 +0,0 @@
-import { DialogWindow } from "../common/dialog-window.model";
-import { ExtraStyles } from "../common/extra-styles.model";
-import { FrontendFields } from "../common/frontend-fields.model";
-import { SectionType } from "../common/section-type.enum";
-import { FrontendGroup } from "./frontend-group.model";
-export interface FrontendSmallSection {
-    title: String;
-    groups: Array<FrontendGroup>;
-    sectionType: SectionType;
-    items?: Array<Array<FrontendFields>>;
-    extraStyles?: ExtraStyles;
-    dialogWindow?: DialogWindow;
-}

package/lib/models/digicust/frontend-small-section.mode.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/digicust/hs-code-mapping.d.ts

@@ -1,26 +0,0 @@
-/**
- * Maps an HS code according to a predefined pattern
- */
-export interface HSCodeMapping {
-    id?: string;
-    customerId?: string;
-    projectId?: string;
-    conditions: {
-        materialNumber?: string;
-        buyerArticleNumber?: string;
-        CAS?: string;
-        description?: string;
-        hsCode?: string;
-        countryOfOrigin?: string;
-        shipperVAT?: string;
-        shipperEORI?: string;
-        shipperName?: string;
-        code?: string;
-    };
-    mapTo: {
-        hsCode?: string;
-        description?: string;
-    };
-    source?: string;
-    createdAt?: Date;
-}

package/lib/models/digicust/hs-code-mapping.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });