digicust_types 1.7.321 → 1.7.322

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

@@ -0,0 +1,72 @@
+/**
+ * This module was automatically generated by `ts-interface-builder`
+ */
+import * as t from "ts-interface-checker";
+// tslint:disable:object-literal-key-quotes
+
+export const Event = t.iface([], {
+  "checkpoint": t.opt("string"),
+  "suppressMultipleExecutions": t.opt("boolean"),
+  "type": t.opt("EventType"),
+});
+
+export const EventType = t.enumtype({
+  "webhook": "webhook",
+  "mail": "email",
+  "sftp": "sftp",
+  "mountedSFTP": "mountedSFTP",
+});
+
+export const WebhookEvent = t.iface(["Event"], {
+  "type": t.enumlit("EventType", "webhook"),
+  "url": t.opt("string"),
+  "method": t.opt(t.union(t.lit("get"), t.lit("post"), t.lit("patch"), t.lit("delete"), t.lit("put"))),
+  "body": t.opt("any"),
+  "bodyMapping": t.opt("string"),
+  "contentType": t.opt("string"),
+});
+
+export const SFTPEvent = t.iface(["Event"], {
+  "type": t.enumlit("EventType", "sftp"),
+  "caseFileMapping": "CaseFileMapping",
+  "sftp-password": "string",
+  "sftp-login-name": "string",
+  "sftp-port": "string",
+  "sftp-dns-name": "string",
+  "sftp-path": "string",
+});
+
+export const EmailEvent = t.iface(["Event"], {
+  "type": t.enumlit("EventType", "mail"),
+  "emailAddress": t.opt("string"),
+  "title": t.opt("string"),
+  "titleMapping": t.opt("string"),
+  "body": t.opt("any"),
+  "bodyMapping": t.opt("string"),
+  "attachDocuments": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+    "fileNameMapping": t.opt("string"),
+  })),
+  "attachCase": t.opt(t.intersection(t.iface([], {
+    "active": t.opt("boolean"),
+  }), "CaseFileMapping")),
+});
+
+export const CaseFileMapping = t.iface([], {
+  "format": t.opt(t.union(t.lit("JSON"), t.lit("CSV"), t.lit("XML"), t.lit("TXT"))),
+  "fileNameMapping": t.opt("string"),
+  "mapping": t.opt("string"),
+  "csvSeparator": t.opt("string"),
+  "includeHeaders": t.opt("boolean"),
+  "removeAccents": t.opt("boolean"),
+});
+
+const exportedTypeSuite: t.ITypeSuite = {
+  Event,
+  EventType,
+  WebhookEvent,
+  SFTPEvent,
+  EmailEvent,
+  CaseFileMapping,
+};
+export default exportedTypeSuite;

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

@@ -0,0 +1,64 @@
+/**
+ * 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

@@ -0,0 +1,10 @@
+"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/execution-strategy.model.d-ti.ts

@@ -0,0 +1,102 @@
+/**
+ * This module was automatically generated by `ts-interface-builder`
+ */
+import * as t from "ts-interface-checker";
+// tslint:disable:object-literal-key-quotes
+
+export const ExecutionStrategy = t.iface([], {
+  "id": t.opt("string"),
+  "alias": t.opt("string"),
+  "moduleId": t.opt("string"),
+  "customerId": t.opt("string"),
+  "projectId": t.opt("string"),
+  "isCondensed": t.opt("boolean"),
+  "subscriptionId": t.opt("string"),
+  "procedureCode": t.opt("string"),
+  "importViaSFTP": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+    "sftp-password": t.opt("string"),
+    "sftp-login-name": t.opt("string"),
+    "sftp-port": t.opt("string"),
+    "sftp-dns-name": t.opt("string"),
+    "sftp-inbound": t.opt("string"),
+    "sftp-outbound": t.opt("string"),
+  })),
+  "whitelistedImportEmails": t.opt(t.array("string")),
+  "defaultClassification": t.opt("DigicustDocumentType"),
+  "defaultProcedureMode": t.opt("ProcedureMode"),
+  "dataExtraction": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+    "exportOnConfirmedStrategy": t.opt("boolean"),
+    "queueMapping": t.opt(t.array(t.iface([], {
+      "documentType": "DigicustDocumentType",
+      "queueId": "string",
+    }))),
+    "classification": t.opt(t.iface([], {
+      "automateOnMinConfidence": t.opt("boolean"),
+      "automateMinConfidence": t.opt("number"),
+    })),
+    "rossumExportOnConfirmed": t.opt("boolean"),
+    "overrideQueues": t.opt(t.array(t.iface([], {
+      "documentType": "string",
+      "queue": "number",
+    }))),
+  })),
+  "dataNormalization": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+    "additionalCostsStrategy": t.opt(t.union(t.lit("addToFirstItem"), t.lit("splitToAllItems"))),
+    "allowDateInOrderNumber": t.opt("boolean"),
+    "normalizeEmailDocuments": t.opt("boolean"),
+    "customsTariffNumberNormalizationSettings": t.opt("CustomsTariffNumberNormalizationSettings"),
+  })),
+  "dataValidation": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+  })),
+  "hsClassification": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+    "research": t.opt("boolean"),
+  })),
+  "dakosySubmission": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+  })),
+  "dataIntegration": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+  })),
+  "pseudonymization": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+    "interval": t.opt("number"),
+    "time": t.opt("number"),
+  })),
+  "isProcessWithDextor": "boolean",
+  "submission": t.opt(t.union(t.iface([], {
+    "active": t.opt("boolean"),
+    "vendor": t.opt(t.lit("dakosy")),
+    "config": t.opt(t.iface([], {
+      "sftp-password": t.opt("string"),
+      "sftp-login-name": t.opt("string"),
+      "sftp-port": t.opt("string"),
+      "sftp-dns-name": t.opt("string"),
+      "sftp-inbound": t.opt("string"),
+      "sftp-outbound": t.opt("string"),
+      "partner-id": t.opt("string"),
+    })),
+  }), t.iface([], {
+    "active": t.opt("boolean"),
+    "vendor": t.opt(t.lit("aeb")),
+    "config": t.opt(t.iface([], {
+      "client-name": t.opt("string"),
+      "user-name": t.opt("string"),
+      "password": t.opt("string"),
+      "endpoint": t.opt("string"),
+      "client-system-id": t.opt("string"),
+      "client-ident-code": t.opt("string"),
+    })),
+  }))),
+  "events": t.array("Event"),
+  "automated": t.opt("boolean"),
+});
+
+const exportedTypeSuite: t.ITypeSuite = {
+  ExecutionStrategy,
+};
+export default exportedTypeSuite;

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

@@ -104,4 +104,4 @@ export interface ExecutionStrategy {
     events: Event[];
     automated?: boolean;
 }
-export declare const condenseExecutionStrategy: (strategy?: ExecutionStrategy) => ExecutionStrategy | null;
+export declare const condenseExecutionStrategy: (strategy?: ExecutionStrategy | undefined) => ExecutionStrategy | null;

package/lib/models/digicust/execution-strategy/index.d-ti.ts

@@ -0,0 +1,11 @@
+/**
+ * This module was automatically generated by `ts-interface-builder`
+ */
+import * as t from "ts-interface-checker";
+// tslint:disable:object-literal-key-quotes
+
+
+
+const exportedTypeSuite: t.ITypeSuite = {
+};
+export default exportedTypeSuite;

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

@@ -0,0 +1,101 @@
+/**
+ * This module was automatically generated by `ts-interface-builder`
+ */
+import * as t from "ts-interface-checker";
+// tslint:disable:object-literal-key-quotes
+
+export const ExecutionStrategy = t.iface([], {
+  "id": t.opt("string"),
+  "alias": t.opt("string"),
+  "moduleId": t.opt("string"),
+  "customerId": t.opt("string"),
+  "projectId": t.opt("string"),
+  "isCondensed": t.opt("boolean"),
+  "subscriptionId": t.opt("string"),
+  "procedureCode": t.opt("string"),
+  "importViaSFTP": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+    "sftp-password": t.opt("string"),
+    "sftp-login-name": t.opt("string"),
+    "sftp-port": t.opt("string"),
+    "sftp-dns-name": t.opt("string"),
+    "sftp-inbound": t.opt("string"),
+    "sftp-outbound": t.opt("string"),
+  })),
+  "whitelistedImportEmails": t.opt(t.array("string")),
+  "defaultClassification": t.opt("DigicustDocumentType"),
+  "defaultProcedureMode": t.opt("ProcedureMode"),
+  "dataExtraction": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+    "exportOnConfirmedStrategy": t.opt("boolean"),
+    "queueMapping": t.opt(t.array(t.iface([], {
+      "documentType": "DigicustDocumentType",
+      "queueId": "string",
+    }))),
+    "classification": t.opt(t.iface([], {
+      "automateOnMinConfidence": t.opt("boolean"),
+      "automateMinConfidence": t.opt("number"),
+    })),
+    "rossumExportOnConfirmed": t.opt("boolean"),
+    "overrideQueues": t.opt(t.array(t.iface([], {
+      "documentType": "string",
+      "queue": "number",
+    }))),
+  })),
+  "dataNormalization": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+    "additionalCostsStrategy": t.opt(t.union(t.lit("addToFirstItem"), t.lit("splitToAllItems"))),
+    "allowDateInOrderNumber": t.opt("boolean"),
+    "customsTariffNumberNormalizationSettings": t.opt("CustomsTariffNumberNormalizationSettings"),
+  })),
+  "dataValidation": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+  })),
+  "hsClassification": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+    "research": t.opt("boolean"),
+  })),
+  "dakosySubmission": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+  })),
+  "dataIntegration": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+  })),
+  "pseudonymization": t.opt(t.iface([], {
+    "active": t.opt("boolean"),
+    "interval": t.opt("number"),
+    "time": t.opt("number"),
+  })),
+  "isProcessWithDextor": "boolean",
+  "submission": t.opt(t.union(t.iface([], {
+    "active": t.opt("boolean"),
+    "vendor": t.opt(t.lit("dakosy")),
+    "config": t.opt(t.iface([], {
+      "sftp-password": t.opt("string"),
+      "sftp-login-name": t.opt("string"),
+      "sftp-port": t.opt("string"),
+      "sftp-dns-name": t.opt("string"),
+      "sftp-inbound": t.opt("string"),
+      "sftp-outbound": t.opt("string"),
+      "partner-id": t.opt("string"),
+    })),
+  }), t.iface([], {
+    "active": t.opt("boolean"),
+    "vendor": t.opt(t.lit("aeb")),
+    "config": t.opt(t.iface([], {
+      "client-name": t.opt("string"),
+      "user-name": t.opt("string"),
+      "password": t.opt("string"),
+      "endpoint": t.opt("string"),
+      "client-system-id": t.opt("string"),
+      "client-ident-code": t.opt("string"),
+    })),
+  }))),
+  "events": t.array("Event"),
+  "automated": t.opt("boolean"),
+});
+
+const exportedTypeSuite: t.ITypeSuite = {
+  ExecutionStrategy,
+};
+export default exportedTypeSuite;

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

@@ -0,0 +1,107 @@
+import { DigicustDocumentType } from ".";
+import { Event } from "./event.model";
+import { ProcedureMode } from "./procedure.model";
+import { CustomsTariffNumberNormalizationSettings } from "./settings";
+/**
+ * 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;
+        customsTariffNumberNormalizationSettings?: CustomsTariffNumberNormalizationSettings;
+    };
+    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

@@ -0,0 +1,15 @@
+"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-ti.ts

@@ -0,0 +1,34 @@
+/**
+ * This module was automatically generated by `ts-interface-builder`
+ */
+import * as t from "ts-interface-checker";
+// tslint:disable:object-literal-key-quotes
+
+export const ExtractionGrid = t.iface([], {
+  "id": t.opt("string"),
+  "label": t.opt("string"),
+  "bbox": t.opt("Bbox"),
+  "pageId": t.opt("string"),
+  "columns": t.opt(t.array("ExtractionGridColumn")),
+  "items": t.opt(t.array("ExtractionGridItem")),
+  "gridGroupId": t.opt("string"),
+});
+
+export const ExtractionGridItem = t.iface([], {
+  "id": t.opt("string"),
+  "fields": t.opt(t.array("ExtractionField")),
+  "bbox": t.opt("Bbox"),
+});
+
+export const ExtractionGridColumn = t.iface([], {
+  "id": t.opt("string"),
+  "label": t.opt("string"),
+  "bbox": t.opt("Bbox"),
+});
+
+const exportedTypeSuite: t.ITypeSuite = {
+  ExtractionGrid,
+  ExtractionGridItem,
+  ExtractionGridColumn,
+};
+export default exportedTypeSuite;

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

@@ -0,0 +1,22 @@
+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

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

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

@@ -0,0 +1,78 @@
+/**
+ * This module was automatically generated by `ts-interface-builder`
+ */
+import * as t from "ts-interface-checker";
+// tslint:disable:object-literal-key-quotes
+
+export const Extraction = t.iface([], {
+  "id": t.opt("string"),
+  "customerId": t.opt("string"),
+  "projectId": t.opt("string"),
+  "caseId": t.opt("string"),
+  "documentId": t.opt("string"),
+  "pages": t.opt(t.array("ExtractionPage")),
+  "groups": t.opt(t.array("ExtractionGroup")),
+  "grids": t.opt(t.array("ExtractionGrid")),
+  "errors": t.opt(t.array("Error")),
+  "originalFileName": t.opt("string"),
+  "fileName": t.opt("string"),
+  "documentType": t.opt("string"),
+  "documentStatus": t.opt("string"),
+  "userDocumentStatus": t.opt("string"),
+  "subDocumentStatus": t.opt("string"),
+  "receivedAt": t.opt("string"),
+  "code": t.opt("string"),
+  "reference": t.opt("string"),
+  "issueDate": t.opt("string"),
+  "isCondensed": t.opt("boolean"),
+  "processing": t.opt("ProcessingModel"),
+  "analyzerMetadata": t.opt(t.iface([], {
+    "importStatus": t.opt("string"),
+    "annotationId": t.opt("string"),
+    "queueId": t.opt("string"),
+    "exportOnConfirmed": t.opt("boolean"),
+  })),
+  "queueId": t.opt("string"),
+  "isLoading": t.opt("boolean"),
+});
+
+export const ProcessingModel = t.iface([], {
+  "status": t.opt(t.union(t.lit("done"), t.lit("inprocess"), t.lit("error"))),
+  "percentage": t.opt("number"),
+  "date": t.opt("Date"),
+  "errorMessage": t.opt("string"),
+});
+
+export const ExtractionGroup = t.iface([], {
+  "id": t.opt("string"),
+  "label": t.opt("string"),
+  "fields": t.opt(t.array("ExtractionField")),
+});
+
+export const ExtractionField = t.iface([], {
+  "id": t.opt("string"),
+  "label": t.opt("string"),
+  "confidence": t.opt("number"),
+  "value": t.opt("string"),
+  "bbox": t.opt("Bbox"),
+  "pageId": t.opt("string"),
+  "name": t.opt("string"),
+  "active": t.opt("boolean"),
+  "dataType": t.opt("string"),
+});
+
+export const ExtractionPage = t.iface([], {
+  "id": t.opt("string"),
+  "width": t.opt("number"),
+  "height": t.opt("number"),
+  "label": t.opt("string"),
+});
+
+const exportedTypeSuite: t.ITypeSuite = {
+  Extraction,
+  ProcessingModel,
+  ExtractionGroup,
+  ExtractionField,
+  ExtractionPage,
+};
+export default exportedTypeSuite;