digicust_types 1.8.9 → 1.8.11

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

@@ -1,66 +1,66 @@
-/**
- * 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;
-    /** Remove tags that are "", null or undefined from output. Defaults to false */
-    removeEmptyTags?: boolean;
-    /** 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;
+    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;
+    /** Remove tags that are "", null or undefined from output. Defaults to false */
+    removeEmptyTags?: boolean;
+    /** Delimiter for CSV mapping */
+    csvSeparator?: string;
+    /** Include headers in CSV */
+    includeHeaders?: boolean;
+    /** Remove non-latin symbols */
+    removeAccents?: boolean;
+}

package/lib/models/digicust/event/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 = EventType = {}));

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

@@ -1 +1 @@
-export * from "./event.model";
+export * from "./event.model";

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

@@ -1,17 +1,17 @@
-"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("./event.model"), exports);
+"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("./event.model"), exports);

package/lib/models/digicust/exchange-rate/exchange-rate.model.d.ts

@@ -1,8 +1,8 @@
-export interface ExchangeRateModel {
-    country: string;
-    currency: string;
-    isoA3Code: string;
-    isoA2Code: string;
-    value: number;
-    comment: string;
-}
+export interface ExchangeRateModel {
+    country: string;
+    currency: string;
+    isoA3Code: string;
+    isoA2Code: string;
+    value: number;
+    comment: string;
+}

package/lib/models/digicust/exchange-rate/exchange-rate.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/exchange-rate/index.d.ts

@@ -1 +1 @@
-export * from './exchange-rate.model';
+export * from "./exchange-rate.model";

package/lib/models/digicust/exchange-rate/index.js

@@ -1,17 +1,17 @@
-"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("./exchange-rate.model"), exports);
+"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("./exchange-rate.model"), exports);

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

@@ -1,130 +1,128 @@
-import { DigicustDocumentType, Event, ProcedureMode, CustomsTariffNumberNormalizationSettings, Rule } from "..";
-/**
- * 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;
-        /** Determines whether or not data from incoming emails are extracted and normalized.
-         * @default false */
-        normalizeEmailDocuments?: boolean;
-        /** Determines whether trade preference shall be invalidated if wording or spelling is wrong */
-        checkTradePreferenceForWording?: boolean;
-        translateLineItemDescriptions?: {
-            active?: boolean;
-            destinationLanguage?: string;
-        };
-        customsTariffNumberNormalizationSettings?: CustomsTariffNumberNormalizationSettings;
-        guaranteeValueStrategy?: "headerFromInvoices" | "lineItems";
-    };
-    dataValidation?: {
-        active?: boolean;
-    };
-    hsClassification?: {
-        active?: boolean;
-        research?: boolean;
-    };
-    /** @deprecated */
-    dakosySubmission?: {
-        active?: boolean;
-    };
-    dataIntegration?: {
-        active?: boolean;
-        requireUserInput?: 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;
-            division?: string;
-            noDocumentsOnHead?: boolean;
-            packagesOnFirstLineItemOnly?: boolean;
-        };
-    } | {
-        active?: boolean;
-        vendor?: "aeb";
-        config?: {
-            "client-name"?: string;
-            "user-name"?: string;
-            password?: string;
-            endpoint?: string;
-            "client-system-id"?: string;
-            "client-ident-code"?: string;
-            profile?: string;
-            organizationalUnit?: string;
-        };
-    } | {
-        active?: boolean;
-        vendor?: "dbh";
-        config?: {
-            "client-code"?: string;
-            "user-name"?: string;
-            password?: string;
-            endpoint?: string;
-        };
-    };
-    events: Event[];
-    rules: Rule[];
-    automated?: boolean;
-}
-export declare const condenseExecutionStrategy: (strategy?: ExecutionStrategy) => ExecutionStrategy | null;
+import { CustomsTariffNumberNormalizationSettings, DigicustDocumentType, Event, PackageType, ProcedureMode, Rule, StakeholderModel } from "..";
+import { AebSftpConfig, DakosySftpConfig, DbhSftpConfig, LdvSftpConfig } from "./sftp-config.model";
+/**
+ * Execution strategies are customer-configurable plans on how to process a specific case.
+ */
+export interface ExecutionStrategy {
+    id?: string;
+    alias?: string;
+    flags?: {
+        [key: string]: 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[];
+    mergeMultipleUploads?: boolean;
+    defaultClassification?: DigicustDocumentType;
+    defaultProcedureMode?: ProcedureMode;
+    dataExtraction?: {
+        active?: boolean;
+        engine?: "default" | "dexter_experimental";
+        engineSpecification?: string;
+        promptRemarks?: string;
+        requireManualClassification?: 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;
+        eliminateArticleNumberFromDescription?: boolean;
+        /** Determines whether or not data from incoming emails are extracted and normalized.
+         * @default false */
+        normalizeEmailDocuments?: boolean;
+        /** Determines whether trade preference shall be invalidated if wording or spelling is wrong */
+        checkTradePreferenceForWording?: boolean;
+        translateLineItemDescriptions?: {
+            active?: boolean;
+            destinationLanguage?: string;
+        };
+        customsTariffNumberNormalizationSettings?: CustomsTariffNumberNormalizationSettings;
+        guaranteeValueStrategy?: "headerFromInvoices" | "headerFromInvoiceHeader" | "lineItems";
+        guaranteeValueCalculation?: "includeVAT19%" | "excludeVAT";
+        waybillCodePreference?: "singleCode" | "seperateCodes";
+        calculateLineItemWeight?: "byQuantity" | "byTotalValue";
+        /** Between 0 and 1 */
+        foreignFreightCostRate?: number;
+        useQuantityAsPackageCount?: boolean;
+        enforcePackageType?: PackageType;
+        preferWeightFromHead?: boolean;
+    };
+    dataValidation?: {
+        active?: boolean;
+        fraudDetection?: boolean;
+    };
+    hsClassification?: {
+        active?: boolean;
+        research?: boolean;
+    };
+    /** @deprecated */
+    dakosySubmission?: {
+        active?: boolean;
+    };
+    dataIntegration?: {
+        active?: boolean;
+        requireUserInput?: "false" | "true" | "masterDataOrUserInput";
+    };
+    matchingEngine?: {
+        materialMatching?: {
+            disabled?: boolean;
+            disableTariffNumberMatching?: boolean;
+            disableMaterialNumberMatching?: boolean;
+            tariffNumberMatchingConfiguration?: {
+                stakeholderFilters?: ("shipper" | "consignee" | "recipient" | "beneficiary" | "applicant" | "declarant" | "importer" | "exporter" | "buyer" | "agent" | "broker" | "carrier" | "warehouse" | "obligater")[];
+            };
+        };
+    };
+    pseudonymization?: {
+        active?: boolean;
+        interval?: number;
+        time?: number;
+    };
+    isProcessWithDextor: boolean;
+    submission?: DakosySftpConfig | AebSftpConfig | DbhSftpConfig | LdvSftpConfig;
+    events: Event[];
+    rules: Rule[];
+    automated?: boolean;
+    customs?: {
+        GRN?: string;
+        GRNAccessCode?: string;
+        declarantRepresentative?: StakeholderModel;
+        LRN?: string;
+    };
+}
+export declare const condenseExecutionStrategy: (strategy?: ExecutionStrategy) => ExecutionStrategy | null;

package/lib/models/digicust/execution-strategy/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/execution-strategy/index.d.ts

@@ -1,2 +1,3 @@
-export * from "./execution-strategy.model";
-export * from "./rule";
+export * from "./execution-strategy.model";
+export * from "./rule";
+export * from "./sftp-config.model";

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

@@ -1,18 +1,19 @@
-"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("./execution-strategy.model"), exports);
-__exportStar(require("./rule"), exports);
+"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("./execution-strategy.model"), exports);
+__exportStar(require("./rule"), exports);
+__exportStar(require("./sftp-config.model"), exports);

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

@@ -1,13 +1,13 @@
-import { UserInput } from "../documents";
-import { FilterCondition } from "../frontend";
-export interface Rule {
-    name?: string;
-    conditions?: {
-        /** Path or JSONata expression */
-        field?: string;
-        operator?: FilterCondition;
-        value?: string;
-    }[];
-    /** User input with replaced fields (according to its priority) */
-    userInput?: UserInput;
-}
+import { UserInput } from "../documents";
+import { FilterCondition } from "../frontend";
+export interface Rule {
+    name?: string;
+    conditions?: {
+        /** Path or JSONata expression */
+        field?: string;
+        operator?: FilterCondition;
+        value?: string;
+    }[];
+    /** User input with replaced fields (according to its priority) */
+    userInput?: UserInput;
+}

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

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