digicust_types 1.7.0 → 1.7.5

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

@@ -1,13 +1,13 @@
-import { Meta } from "../common";
-export interface CustomsOffice extends Meta<any> {
-    code?: string;
-    officeType?: CustomsOfficeType;
-}
-export declare enum CustomsOfficeType {
-    entry = "Entry",
-    exit = "Exit",
-    export = "Export",
-    transit = "Transit",
-    import = "Import",
-    declaration = "Declaration"
-}
+import { Meta } from "../common";
+export interface CustomsOffice extends Meta<any> {
+    code?: string;
+    officeType?: CustomsOfficeType;
+}
+export declare enum CustomsOfficeType {
+    entry = "Entry",
+    exit = "Exit",
+    export = "Export",
+    transit = "Transit",
+    import = "Import",
+    declaration = "Declaration"
+}

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

@@ -1,12 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomsOfficeType = void 0;
-var CustomsOfficeType;
-(function (CustomsOfficeType) {
-    CustomsOfficeType["entry"] = "Entry";
-    CustomsOfficeType["exit"] = "Exit";
-    CustomsOfficeType["export"] = "Export";
-    CustomsOfficeType["transit"] = "Transit";
-    CustomsOfficeType["import"] = "Import";
-    CustomsOfficeType["declaration"] = "Declaration";
-})(CustomsOfficeType = exports.CustomsOfficeType || (exports.CustomsOfficeType = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomsOfficeType = void 0;
+var CustomsOfficeType;
+(function (CustomsOfficeType) {
+    CustomsOfficeType["entry"] = "Entry";
+    CustomsOfficeType["exit"] = "Exit";
+    CustomsOfficeType["export"] = "Export";
+    CustomsOfficeType["transit"] = "Transit";
+    CustomsOfficeType["import"] = "Import";
+    CustomsOfficeType["declaration"] = "Declaration";
+})(CustomsOfficeType = exports.CustomsOfficeType || (exports.CustomsOfficeType = {}));

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

@@ -1,4 +1,4 @@
-export interface Declaration {
-}
-export interface DeclarationType1 extends Declaration {
-}
+export interface Declaration {
+}
+export interface DeclarationType1 extends Declaration {
+}

package/lib/models/digicust/declaration.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/digicust-document-type.enum.d.ts

@@ -1,10 +1,10 @@
-/**
- * Identifies different document types
- */
-export declare enum DigicustDocumentType {
-    Invoice = "invoice",
-    Waybill = "waybill",
-    PackingList = "packingList",
-    TaxInvoice = "taxInvoice",
-    CustomDocument = "customDocument"
-}
+/**
+ * Identifies different document types
+ */
+export declare enum DigicustDocumentType {
+    Invoice = "invoice",
+    Waybill = "waybill",
+    PackingList = "packingList",
+    TaxInvoice = "taxInvoice",
+    CustomDocument = "customDocument"
+}

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

@@ -1,14 +1,14 @@
-"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 = exports.DigicustDocumentType || (exports.DigicustDocumentType = {}));
+"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 = exports.DigicustDocumentType || (exports.DigicustDocumentType = {}));

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

@@ -1,42 +1,42 @@
-import { DigicustDocumentType } from "./digicust-document-type.enum";
-import { DocumentStatus, SubDocumentStatus, UserDocumentStatus } from "./document-status.enum";
-import { RossumImportStatus } from "../rossum";
-import { DateTimeModel } from "../common";
-import { AnalyzerMetadataModel } from "./AnalyzerMetadataModel.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;
-    documentType?: DigicustDocumentType;
-    documentStatus?: DocumentStatus;
-    UserDocumentStatus?: UserDocumentStatus;
-    SubDocumentStatus?: SubDocumentStatus;
-    recievedAt?: 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;
-    };
-    fileName?: string;
-}
-export declare const condenseDocument: (document?: DigicustDocumentModel | undefined) => DigicustDocumentModel | null;
+import { DigicustDocumentType } from "./digicust-document-type.enum";
+import { DocumentStatus, SubDocumentStatus, UserDocumentStatus } from "./document-status.enum";
+import { RossumImportStatus } from "../rossum";
+import { DateTimeModel } from "../common";
+import { AnalyzerMetadataModel } from "./AnalyzerMetadataModel.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;
+    documentType?: DigicustDocumentType;
+    documentStatus?: DocumentStatus;
+    UserDocumentStatus?: UserDocumentStatus;
+    SubDocumentStatus?: SubDocumentStatus;
+    recievedAt?: 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;
+    };
+    fileName?: string;
+}
+export declare const condenseDocument: (document?: DigicustDocumentModel | undefined) => DigicustDocumentModel | null;

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

@@ -1,35 +1,35 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.condenseDocument = void 0;
-var digicust_document_type_enum_1 = require("./digicust-document-type.enum");
-var line_item_model_1 = require("./line-item.model");
-var condenseDocument = function (document) {
-    var doc = document
-        ? {
-            id: document.id,
-            caseId: document.caseId,
-            documentType: document.documentType,
-            documentStatus: document.documentStatus,
-            code: document.code,
-            reference: document.reference,
-            issueDate: document.issueDate,
-            fileName: document.fileName,
-            analyzerMetadata: document.analyzerMetadata,
-            isCondensed: true,
-        }
-        : null;
-    if ((doc === null || doc === void 0 ? void 0 : doc.documentType) === digicust_document_type_enum_1.DigicustDocumentType.Invoice) {
-        var invoice = doc;
-        if (invoice.items) {
-            invoice.items = invoice.items.map(function (item) {
-                var lineItem = line_item_model_1.condenseLineItem(item);
-                if (!lineItem) {
-                    return {};
-                }
-                return lineItem;
-            });
-        }
-    }
-    return doc;
-};
-exports.condenseDocument = condenseDocument;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.condenseDocument = void 0;
+var digicust_document_type_enum_1 = require("./digicust-document-type.enum");
+var line_item_model_1 = require("./line-item.model");
+var condenseDocument = function (document) {
+    var doc = document
+        ? {
+            id: document.id,
+            caseId: document.caseId,
+            documentType: document.documentType,
+            documentStatus: document.documentStatus,
+            code: document.code,
+            reference: document.reference,
+            issueDate: document.issueDate,
+            fileName: document.fileName,
+            analyzerMetadata: document.analyzerMetadata,
+            isCondensed: true,
+        }
+        : null;
+    if ((doc === null || doc === void 0 ? void 0 : doc.documentType) === digicust_document_type_enum_1.DigicustDocumentType.Invoice) {
+        var invoice = doc;
+        if (invoice.items) {
+            invoice.items = invoice.items.map(function (item) {
+                var lineItem = (0, line_item_model_1.condenseLineItem)(item);
+                if (!lineItem) {
+                    return {};
+                }
+                return lineItem;
+            });
+        }
+    }
+    return doc;
+};
+exports.condenseDocument = condenseDocument;

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

@@ -1,29 +1,29 @@
-/**
- * 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"
-}
+/**
+ * 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"
+}

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

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

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

@@ -1,42 +1,42 @@
-/**
- * Base model of an event (e.g. webhook or email)
- */
-export interface Event {
-    checkpoint?: string;
-    suppressMultipleExecutions?: boolean;
-    type?: "webhook" | "email";
-}
-export declare enum EventType {
-    webhook = "webhook",
-    mail = "email"
-}
-export interface WebhookEvent extends Event {
-    type: "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 EmailEvent extends Event {
-    type: "email";
-    emailAddress?: string;
-    body?: any;
-    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
-    bodyMapping?: string;
-    attachDocuments?: {
-        active?: boolean;
-    };
-    attachCase?: {
-        active?: boolean;
-        format?: "JSON" | "CSV" | "XML" | "TXT";
-        csvSeparator?: string;
-        includeHeaders?: boolean;
-        removeAccents?: boolean;
-        /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
-        fileNameMapping?: string;
-        /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
-        mapping?: string;
-    };
-}
+/**
+ * Base model of an event (e.g. webhook or email)
+ */
+export interface Event {
+    checkpoint?: string;
+    suppressMultipleExecutions?: boolean;
+    type?: "webhook" | "email";
+}
+export declare enum EventType {
+    webhook = "webhook",
+    mail = "email"
+}
+export interface WebhookEvent extends Event {
+    type: "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 EmailEvent extends Event {
+    type: "email";
+    emailAddress?: string;
+    body?: any;
+    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
+    bodyMapping?: string;
+    attachDocuments?: {
+        active?: boolean;
+    };
+    attachCase?: {
+        active?: boolean;
+        format?: "JSON" | "CSV" | "XML" | "TXT";
+        csvSeparator?: string;
+        includeHeaders?: boolean;
+        removeAccents?: boolean;
+        /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
+        fileNameMapping?: string;
+        /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
+        mapping?: string;
+    };
+}

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

@@ -1,8 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventType = void 0;
-var EventType;
-(function (EventType) {
-    EventType["webhook"] = "webhook";
-    EventType["mail"] = "email";
-})(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 = exports.EventType || (exports.EventType = {}));

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

@@ -1,53 +1,53 @@
-import { DigicustDocumentType } from "./digicust-document-type.enum";
-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;
-    whitelistedImportEmails?: string[];
-    defaultClassification?: DigicustDocumentType;
-    dataExtraction?: {
-        active?: boolean;
-        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;
-        };
-        exportOnConfirmedStrategy?: boolean;
-        /**
-         * @deprecated
-         */
-        rossumExportOnConfirmed?: boolean;
-        overrideQueues?: {
-            documentType: string;
-            queue: number;
-        }[];
-    };
-    dataNormalization?: {
-        active?: boolean;
-        /** Determines how to deal with additional costs like shipping costs, packing, ... */
-        additionalCostsStrategy?: "addToFirstItem" | "splitToAllItems";
-    };
-    hsClassification?: {
-        active?: boolean;
-        research?: boolean;
-    };
-    dakosySubmission?: {
-        active?: boolean;
-    };
-    dataIntegration?: {
-        active?: boolean;
-    };
-    events: Event[];
-    automated?: boolean;
-}
-export declare const condenseExecutionStrategy: (strategy?: ExecutionStrategy | undefined) => ExecutionStrategy | null;
+import { DigicustDocumentType } from "./digicust-document-type.enum";
+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;
+    whitelistedImportEmails?: string[];
+    defaultClassification?: DigicustDocumentType;
+    dataExtraction?: {
+        active?: boolean;
+        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;
+        };
+        exportOnConfirmedStrategy?: boolean;
+        /**
+         * @deprecated
+         */
+        rossumExportOnConfirmed?: boolean;
+        overrideQueues?: {
+            documentType: string;
+            queue: number;
+        }[];
+    };
+    dataNormalization?: {
+        active?: boolean;
+        /** Determines how to deal with additional costs like shipping costs, packing, ... */
+        additionalCostsStrategy?: "addToFirstItem" | "splitToAllItems";
+    };
+    hsClassification?: {
+        active?: boolean;
+        research?: boolean;
+    };
+    dakosySubmission?: {
+        active?: boolean;
+    };
+    dataIntegration?: {
+        active?: boolean;
+    };
+    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;