digicust_types 1.8.53 → 1.8.55

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

@@ -1,134 +1,136 @@
-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;
-    handleXLSXFileUploads?: "AsLineItemTable" | false;
-    defaultClassification?: DigicustDocumentType;
-    defaultProcedureMode?: ProcedureMode;
-    dataExtraction?: {
-        active?: boolean;
-        engine?: "default" | "dexter_experimental";
-        engineSpecification?: string;
-        promptRemarks?: string;
-        requireManualClassification?: boolean;
-        requireHumanAnnotation?: 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" | "splitToAllItemsByNetWeight" | "splitToAllItemsByTotalValue";
-        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";
-        defaultInvoiceType?: "tax_invoice" | "proforma";
-        /** Between 0 and 1 */
-        foreignFreightCostRate?: number;
-        ignoreLineItemsFromInvoice?: boolean;
-        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;
-            sendMasterDataTariffNumberOnly?: boolean;
-            sendMasterDataDescriptionOnly?: 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;
+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;
+    handleXLSXFileUploads?: "AsLineItemTable" | false;
+    defaultClassification?: DigicustDocumentType;
+    defaultProcedureMode?: ProcedureMode;
+    dataExtraction?: {
+        active?: boolean;
+        engine?: "default" | "dexter_experimental";
+        engineSpecification?: string;
+        promptRemarks?: string;
+        requireManualClassification?: boolean;
+        requireHumanAnnotation?: 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" | "splitToAllItemsByNetWeight" | "splitToAllItemsByTotalValue";
+        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;
+        /** Default: Assume origin from preference. Set to true to mitigate this behavior */
+        doNotAssumeOriginFromPreference?: boolean;
+        translateLineItemDescriptions?: {
+            active?: boolean;
+            destinationLanguage?: string;
+        };
+        customsTariffNumberNormalizationSettings?: CustomsTariffNumberNormalizationSettings;
+        guaranteeValueStrategy?: "headerFromInvoices" | "headerFromInvoiceHeader" | "lineItems";
+        guaranteeValueCalculation?: "includeVAT19%" | "excludeVAT";
+        waybillCodePreference?: "singleCode" | "seperateCodes";
+        calculateLineItemWeight?: "byQuantity" | "byTotalValue";
+        defaultInvoiceType?: "tax_invoice" | "proforma";
+        /** Between 0 and 1 */
+        foreignFreightCostRate?: number;
+        ignoreLineItemsFromInvoice?: boolean;
+        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;
+            sendMasterDataTariffNumberOnly?: boolean;
+            sendMasterDataDescriptionOnly?: 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;

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

@@ -1,13 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.condenseExecutionStrategy = void 0;
-const condenseExecutionStrategy = (strategy) => 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;
+const condenseExecutionStrategy = (strategy) => 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,3 +1,3 @@
-export * from "./execution-strategy.model";
-export * from "./rule";
-export * from "./sftp-config.model";
+export * from "./execution-strategy.model";
+export * from "./rule";
+export * from "./sftp-config.model";

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

@@ -1,19 +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);
-__exportStar(require("./sftp-config.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("./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 });

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

@@ -1,61 +1,61 @@
-export interface DakosySftpConfig {
-    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;
-        aggregateItems?: boolean;
-        template?: string;
-        ignoreDV1?: boolean;
-        ignoreToAddress?: boolean;
-        /** Anmelder ist Empfanger */
-        enforceImportDeclarantIsRecipient?: boolean;
-    };
-}
-export interface LdvSftpConfig {
-    active?: boolean;
-    vendor?: "ldv";
-    config?: {
-        "sftp-password"?: string;
-        "sftp-login-name"?: string;
-        "sftp-port"?: string;
-        "sftp-dns-name"?: string;
-        "sftp-inbound"?: string;
-    };
-}
-export interface DbhSftpConfig {
-    active?: boolean;
-    vendor?: "dbh";
-    config?: {
-        "client-code"?: string;
-        "user-name"?: string;
-        password?: string;
-        endpoint?: string;
-        template?: string;
-        aggregateItems?: boolean;
-        duplicateBTIsInAdditionalInformationField?: boolean;
-        aggregateFreightAndGoodsInvoices?: boolean;
-    };
-}
-export interface AebSftpConfig {
-    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;
-    };
-}
+export interface DakosySftpConfig {
+    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;
+        aggregateItems?: boolean;
+        template?: string;
+        ignoreDV1?: boolean;
+        ignoreToAddress?: boolean;
+        /** Anmelder ist Empfanger */
+        enforceImportDeclarantIsRecipient?: boolean;
+    };
+}
+export interface LdvSftpConfig {
+    active?: boolean;
+    vendor?: "ldv";
+    config?: {
+        "sftp-password"?: string;
+        "sftp-login-name"?: string;
+        "sftp-port"?: string;
+        "sftp-dns-name"?: string;
+        "sftp-inbound"?: string;
+    };
+}
+export interface DbhSftpConfig {
+    active?: boolean;
+    vendor?: "dbh";
+    config?: {
+        "client-code"?: string;
+        "user-name"?: string;
+        password?: string;
+        endpoint?: string;
+        template?: string;
+        aggregateItems?: boolean;
+        duplicateBTIsInAdditionalInformationField?: boolean;
+        aggregateFreightAndGoodsInvoices?: boolean;
+    };
+}
+export interface AebSftpConfig {
+    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;
+    };
+}

package/lib/models/digicust/execution-strategy/sftp-config.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/fraud/item-fraud-detection.d.ts

@@ -1,6 +1,6 @@
-export interface ItemFraudDetectionDetails {
-    /** Number between 0 and 1 */
-    score?: number;
-    reason?: string;
-    detector?: string;
-}
+export interface ItemFraudDetectionDetails {
+    /** Number between 0 and 1 */
+    score?: number;
+    reason?: string;
+    detector?: string;
+}

package/lib/models/digicust/fraud/item-fraud-detection.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/frontend/dialog-window.model.d.ts

@@ -1,6 +1,6 @@
-import { FrontendFields } from "./frontend-fields.model";
-export interface DialogWindow {
-    number: number;
-    title: string;
-    fields: Array<FrontendFields>;
-}
+import { FrontendFields } from "./frontend-fields.model";
+export interface DialogWindow {
+    number: number;
+    title: string;
+    fields: Array<FrontendFields>;
+}

package/lib/models/digicust/frontend/dialog-window.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/frontend/extra-styles.model.d.ts

@@ -1,4 +1,4 @@
-export interface ExtraStyles {
-    width?: string;
-    height?: string;
-}
+export interface ExtraStyles {
+    width?: string;
+    height?: string;
+}

package/lib/models/digicust/frontend/extra-styles.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/frontend/field-type.enum.d.ts

@@ -1,10 +1,10 @@
-export declare enum FieldType {
-    text = "text",
-    date = "date",
-    currency = "currency",
-    weight = "weight",
-    dimensions = "dimensions",
-    phoneNumber = "phoneNumber",
-    email = "email",
-    address = "address"
-}
+export declare enum FieldType {
+    text = "text",
+    date = "date",
+    currency = "currency",
+    weight = "weight",
+    dimensions = "dimensions",
+    phoneNumber = "phoneNumber",
+    email = "email",
+    address = "address"
+}

package/lib/models/digicust/frontend/field-type.enum.js

@@ -1,14 +1,14 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldType = void 0;
-var FieldType;
-(function (FieldType) {
-    FieldType["text"] = "text";
-    FieldType["date"] = "date";
-    FieldType["currency"] = "currency";
-    FieldType["weight"] = "weight";
-    FieldType["dimensions"] = "dimensions";
-    FieldType["phoneNumber"] = "phoneNumber";
-    FieldType["email"] = "email";
-    FieldType["address"] = "address";
-})(FieldType = exports.FieldType || (exports.FieldType = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldType = void 0;
+var FieldType;
+(function (FieldType) {
+    FieldType["text"] = "text";
+    FieldType["date"] = "date";
+    FieldType["currency"] = "currency";
+    FieldType["weight"] = "weight";
+    FieldType["dimensions"] = "dimensions";
+    FieldType["phoneNumber"] = "phoneNumber";
+    FieldType["email"] = "email";
+    FieldType["address"] = "address";
+})(FieldType || (exports.FieldType = FieldType = {}));

package/lib/models/digicust/frontend/filter.enum.d.ts

@@ -1,14 +1,14 @@
-export declare enum FilterCondition {
-    greaterThan = "greaterThan",
-    smallerThan = "smallerThan",
-    equals = "equals",
-    startsWith = "startsWith",
-    endsWith = "endsWith",
-    contains = "contains",
-    isUserEdited = "isUserEdited"
-}
-export interface FilterObject {
-    field: string;
-    condition: FilterCondition;
-    value: string | undefined | boolean | Date | number;
-}
+export declare enum FilterCondition {
+    greaterThan = "greaterThan",
+    smallerThan = "smallerThan",
+    equals = "equals",
+    startsWith = "startsWith",
+    endsWith = "endsWith",
+    contains = "contains",
+    isUserEdited = "isUserEdited"
+}
+export interface FilterObject {
+    field: string;
+    condition: FilterCondition;
+    value: string | undefined | boolean | Date | number;
+}