digicust_types 1.7.154 → 1.7.155

package/lib/models/digicust/documents/waybill.model.d.ts

@@ -1,33 +1,33 @@
-import { AddressModel, CompanyModel, Currency, DateTimeModel, Money, Weight } from "../../common";
-import { DigicustDocumentModel } from "./";
-import { Meta } from "../../common/meta";
-import { IncotermModel } from "../incoterm.model";
-import { Package } from "../package.model";
-import { WaybillTypeModel } from "./waybill-type.model";
-/**
- * Identifies a waybill document
- */
-export interface WaybillModel extends DigicustDocumentModel {
-    shipper?: CompanyModel;
-    recipient?: CompanyModel;
-    consignee?: CompanyModel;
-    applicant?: CompanyModel;
-    waybillNumber?: Meta<string>;
-    issueDate?: DateTimeModel;
-    waybillType?: WaybillTypeModel;
-    referenceNumber?: Meta<string>;
-    weight?: Weight;
-    totalValue?: Money;
-    totalValueExcludingCharges?: Money;
-    customsValue?: Money;
-    shippingCost?: Money;
-    otherPayments?: Money;
-    shippingDate?: DateTimeModel;
-    incoterm?: IncotermModel;
-    placeIncoterm?: AddressModel;
-    invoiceNumber?: Meta<string>;
-    goodsDescription?: Meta<string>;
-    currency?: Meta<Currency>;
-    numPackagesShipped?: Meta<number>;
-    packages?: Package[];
-}
+import { AddressModel, CompanyModel, Currency, DateTimeModel, Money, Weight } from "../../common";
+import { DigicustDocumentModel } from "./";
+import { Meta } from "../../common/meta";
+import { IncotermModel } from "../incoterm.model";
+import { Package } from "../package.model";
+import { WaybillTypeModel } from "./waybill-type.model";
+/**
+ * Identifies a waybill document
+ */
+export interface WaybillModel extends DigicustDocumentModel {
+    shipper?: CompanyModel;
+    recipient?: CompanyModel;
+    consignee?: CompanyModel;
+    applicant?: CompanyModel;
+    waybillNumber?: Meta<string>;
+    issueDate?: DateTimeModel;
+    waybillType?: WaybillTypeModel;
+    referenceNumber?: Meta<string>;
+    weight?: Weight;
+    totalValue?: Money;
+    totalValueExcludingCharges?: Money;
+    customsValue?: Money;
+    shippingCost?: Money;
+    otherPayments?: Money;
+    shippingDate?: DateTimeModel;
+    incoterm?: IncotermModel;
+    placeIncoterm?: AddressModel;
+    invoiceNumber?: Meta<string>;
+    goodsDescription?: Meta<string>;
+    currency?: Meta<Currency>;
+    numPackagesShipped?: Meta<number>;
+    packages?: Package[];
+}

package/lib/models/digicust/documents/waybill.model.js

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

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

@@ -1,8 +1,8 @@
-export interface ValidationError extends Error {
-    type: "ValidationError";
-    severity?: "error" | "warning" | "info";
-    field?: string;
-    expected?: any;
-    actual?: any;
-    reference?: string;
-}
+export interface ValidationError extends Error {
+    type: "ValidationError";
+    severity?: "error" | "warning" | "info";
+    field?: string;
+    expected?: any;
+    actual?: any;
+    reference?: string;
+}

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

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

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

@@ -1,59 +1,59 @@
-/**
- * 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;
-    body?: any;
-    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
-    bodyMapping?: string;
-    attachDocuments?: {
-        active?: boolean;
-    };
-    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;
-}
+/**
+ * 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;
+    body?: any;
+    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
+    bodyMapping?: string;
+    attachDocuments?: {
+        active?: boolean;
+    };
+    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 +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 = {}));
+"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,96 +1,96 @@
-import { DigicustDocumentType } from "./";
-import { Event } from "./event.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;
-    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";
-    };
-    dataValidation?: {
-        active?: boolean;
-    };
-    hsClassification?: {
-        active?: boolean;
-        research?: boolean;
-    };
-    /** @deprecated */
-    dakosySubmission?: {
-        active?: boolean;
-    };
-    dataIntegration?: {
-        active?: boolean;
-    };
-    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;
+import { DigicustDocumentType } from "./";
+import { Event } from "./event.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;
+    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";
+    };
+    dataValidation?: {
+        active?: boolean;
+    };
+    hsClassification?: {
+        active?: boolean;
+        research?: boolean;
+    };
+    /** @deprecated */
+    dakosySubmission?: {
+        active?: boolean;
+    };
+    dataIntegration?: {
+        active?: boolean;
+    };
+    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,15 +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;
+"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 +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;
-}
+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 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,65 +1,65 @@
-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;
-}
+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 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

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