digicust_types 1.7.207 → 1.7.210

package/readme.md

@@ -1,48 +1,48 @@
-# types package
-
-This package contains important types for communication with and within Digicust services, including:
-
-- message contracts for communication between services
-- common data types interfaces
-- digicust-specific data structures
-
-## Usage
-
-1. Install Digicust Types package using NPM
-
-```
-npm i digicust_types
-```
-
-2. Import your required interfaces using JavaScript's import module syntax
-
-```javascript
-import {
-  CaseModel,
-  CaseStatus,
-  UploadedFileModel,
-  StartDataExtractionDto,
-  DocumentStatus,
-} from "digicust_types"
-```
-
-## Interfaces
-
-We believe that the definition of the typescript interfaces are their best documentation themselves. Find all models here:
-
-- [General interfaces for data structures](./src/models/common/index.ts)
-- [Business-specific interfaces](./src/models/digicust/index.ts)
-- [Contracts for messages between services](./src/contracts/index.ts)
-
-## Development
-
-```
-tsc
-npm run git deploy
-```
-
-## Deployment
-
-```
-npm run build
-```
+# types package
+
+This package contains important types for communication with and within Digicust services, including:
+
+- message contracts for communication between services
+- common data types interfaces
+- digicust-specific data structures
+
+## Usage
+
+1. Install Digicust Types package using NPM
+
+```
+npm i digicust_types
+```
+
+2. Import your required interfaces using JavaScript's import module syntax
+
+```javascript
+import {
+  CaseModel,
+  CaseStatus,
+  UploadedFileModel,
+  StartDataExtractionDto,
+  DocumentStatus,
+} from "digicust_types"
+```
+
+## Interfaces
+
+We believe that the definition of the typescript interfaces are their best documentation themselves. Find all models here:
+
+- [General interfaces for data structures](./src/models/common/index.ts)
+- [Business-specific interfaces](./src/models/digicust/index.ts)
+- [Contracts for messages between services](./src/contracts/index.ts)
+
+## Development
+
+```
+tsc
+npm run git deploy
+```
+
+## Deployment
+
+```
+npm run build
+```

package/lib/contracts/start-hs-classification.dto.d.ts

@@ -1,3 +0,0 @@
-export interface StartHsClassificationDto {
-    caseId: string;
-}

package/lib/contracts/start-hs-classification.dto.js

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

package/lib/models/common/checkpoint.model.d.ts

@@ -1,21 +0,0 @@
-export interface Checkpoint {
-    id?: string;
-    customerId?: string;
-    context?: string;
-    type?: "webhook" | "email";
-}
-export declare enum CheckPointType {
-    webhook = "webhook",
-    mail = "email"
-}
-export interface WebhookCheckpoint extends Checkpoint {
-    type: "webhook";
-    url?: string;
-    method?: "GET" | "POST" | "PATCH" | "DELETE" | "PUT";
-    body?: any;
-}
-export interface EmailCheckpoint extends Checkpoint {
-    type: "email";
-    emailAddress?: string;
-    body?: any;
-}

package/lib/models/common/checkpoint.model.js

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

package/lib/models/common/country.model.d.ts

@@ -1,4 +0,0 @@
-import { FuzzyInput } from "./fuzzy-input";
-export interface CountryModel extends FuzzyInput<string> {
-    isoCode?: string;
-}

package/lib/models/common/country.model.js

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

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

@@ -1,21 +0,0 @@
-export interface Event {
-    id?: string;
-    customerId?: string;
-    context?: string;
-    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;
-}
-export interface EmailEvent extends Event {
-    type: "email";
-    emailAddress?: string;
-    body?: any;
-}

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

@@ -1,8 +0,0 @@
-"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/common/super.d.ts

@@ -1,7 +0,0 @@
-export interface Super<T> {
-    value: T;
-    options?: T[];
-    lastChangedBy: String;
-    modifiedAt: Date;
-    source: String;
-}

package/lib/models/common/super.js

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

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

@@ -1,12 +0,0 @@
-export interface WorkspaceQueues {
-    QueueId?: string;
-    name?: string;
-    QueueDocumentType?: string;
-    active?: boolean;
-}
-export interface QueueWorkspaceModel {
-    id?: string;
-    name?: string;
-    active?: boolean;
-    queues?: WorkspaceQueues[];
-}

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

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

package/lib/models/digicust/activity.mode.d.ts

@@ -1,18 +0,0 @@
-import { Money } from "../common";
-/**
- * Used to document usage of the service. Every activity can be tracked using this interface
- */
-export interface Activity {
-    id?: string;
-    customerId?: string;
-    projectId?: string;
-    userId?: string;
-    /** An identifier of this type of activity */
-    activityName?: string;
-    description?: string;
-    timestamp?: Date;
-    caseId?: string;
-    subscriptionId?: string;
-    paid?: boolean;
-    extraCosts?: Money;
-}

package/lib/models/digicust/activity.mode.js

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

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

@@ -1,4 +0,0 @@
-export interface CompanyModel {
-    name?: string;
-    apiKey: string;
-}

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

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

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

@@ -1,8 +0,0 @@
-import { DigicustDocumentType } from "./digicust-document-type.enum";
-import { DigicustDocumentModel } from "./digicust-document.model";
-/**
- * Identifies a user-specified case document
- */
-export interface CustomDocumentModel extends DigicustDocumentModel {
-    documentType: DigicustDocumentType.CustomDocument;
-}

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

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

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

@@ -1,15 +0,0 @@
-/**
- * Identifies different document types
- */
-export declare enum DigicustDocumentType {
-    Invoice = "invoice",
-    Waybill = "waybill",
-    PackingList = "packingList",
-    TaxInvoice = "taxInvoice",
-    CustomDocument = "customDocument",
-    ItemListing = "itemListing",
-    CostOverview = "costOverview",
-    DeclarationOfOrigin = "declarationOfOrigin",
-    PreferentialProofOfOrigin = "preferentialProofOfOrigin",
-    ProofOfDirectTransport = "proofOfDirectTransport"
-}

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

@@ -1,19 +0,0 @@
-"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["ItemListing"] = "itemListing";
-    DigicustDocumentType["CostOverview"] = "costOverview";
-    DigicustDocumentType["DeclarationOfOrigin"] = "declarationOfOrigin";
-    DigicustDocumentType["PreferentialProofOfOrigin"] = "preferentialProofOfOrigin";
-    DigicustDocumentType["ProofOfDirectTransport"] = "proofOfDirectTransport";
-})(DigicustDocumentType = exports.DigicustDocumentType || (exports.DigicustDocumentType = {}));

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

@@ -1,45 +0,0 @@
-import { ClassificationStatus, DigicustDocumentType, DocumentCode, DocumentStatus, SubDocumentStatus, UserDocumentStatus } from ".";
-import { DateTimeModel, RossumImportStatus } from "..";
-import { AnalyzerMetadataModel } from "./AnalyzerMetadataModel.model";
-import { ProcessingModel } from "./extractions/extraction.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;
-    extractId?: string;
-    fileName?: string;
-    documentType?: DigicustDocumentType;
-    documentCode?: DocumentCode;
-    documentStatus?: DocumentStatus;
-    userDocumentStatus?: UserDocumentStatus;
-    subDocumentStatus?: SubDocumentStatus;
-    classificationStatus?: ClassificationStatus;
-    processing?: ProcessingModel;
-    receivedAt?: 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;
-    };
-}
-export declare const condenseDocument: (document?: DigicustDocumentModel | undefined) => DigicustDocumentModel | null;

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

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.condenseDocument = void 0;
-var _1 = require(".");
-var condenseDocument = function (document) {
-    var doc = document
-        ? {
-            id: document.id,
-            caseId: document.caseId,
-            queueId: document.queueId,
-            fileName: document.fileName,
-            documentType: document.documentType,
-            documentStatus: document.documentStatus,
-            userDocumentStatus: document.UserDocumentStatus,
-            subDocumentStatus: document.SubDocumentStatus,
-            classificationStatus: document.classificationStatus,
-            code: document.code,
-            reference: document.reference,
-            issueDate: document.issueDate,
-            analyzerMetadata: document.analyzerMetadata,
-            isCondensed: true,
-        }
-        : null;
-    if ((doc === null || doc === void 0 ? void 0 : doc.documentType) === _1.DigicustDocumentType.Invoice) {
-        var invoice = doc;
-        if (invoice.items) {
-            invoice.items = invoice.items.map(function (item) {
-                var lineItem = (0, _1.condenseLineItem)(item);
-                if (!lineItem) {
-                    return {};
-                }
-                return lineItem;
-            });
-        }
-    }
-    return doc;
-};
-exports.condenseDocument = condenseDocument;

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

@@ -1,12 +0,0 @@
-import { Meta } from "../common";
-import { DigicustDocumentType } from "./digicust-document-type.enum";
-/**
- * Coding of documents
- */
-export interface DocumentCode extends Meta<DigicustDocumentType> {
-    NC_24000?: string;
-    Dokumentenarten?: string;
-    DE_I0200?: string;
-    /** Bescheinigungsbereich */
-    DE_I0200_Bereich?: string;
-}

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

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

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

@@ -1,38 +0,0 @@
-/**
- * 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"
-}
-export declare enum ClassificationStatus {
-    Edit = "edit",
-    OnHold = "onhold",
-    Edited = "edited",
-    Refused = "refused",
-    Finished = "finished",
-    Erased = "erased",
-    OtherDocs = "otherdocs"
-}

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

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClassificationStatus = 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 = {}));
-var ClassificationStatus;
-(function (ClassificationStatus) {
-    ClassificationStatus["Edit"] = "edit";
-    ClassificationStatus["OnHold"] = "onhold";
-    ClassificationStatus["Edited"] = "edited";
-    ClassificationStatus["Refused"] = "refused";
-    ClassificationStatus["Finished"] = "finished";
-    ClassificationStatus["Erased"] = "erased";
-    ClassificationStatus["OtherDocs"] = "otherdocs";
-})(ClassificationStatus = exports.ClassificationStatus || (exports.ClassificationStatus = {}));

package/lib/models/digicust/incoterm.enum.d.ts

@@ -1,17 +0,0 @@
-/**
- * Incoterms give information on transport conditions in international trade
- */
-export declare enum Incoterm {
-    EXW = "EXW",
-    FAS = "FAS",
-    FCA = "FCA",
-    FOB = "FOB",
-    CFR = "CFR",
-    CIF = "CIF",
-    CIP = "CIP",
-    CPT = "CPT",
-    DAP = "DAP",
-    DPU = "DPU",
-    DAT = "DAT",
-    DDP = "DDP"
-}

package/lib/models/digicust/incoterm.enum.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Incoterm = void 0;
-/**
- * Incoterms give information on transport conditions in international trade
- */
-var Incoterm;
-(function (Incoterm) {
-    Incoterm["EXW"] = "EXW";
-    Incoterm["FAS"] = "FAS";
-    Incoterm["FCA"] = "FCA";
-    Incoterm["FOB"] = "FOB";
-    Incoterm["CFR"] = "CFR";
-    Incoterm["CIF"] = "CIF";
-    Incoterm["CIP"] = "CIP";
-    Incoterm["CPT"] = "CPT";
-    Incoterm["DAP"] = "DAP";
-    Incoterm["DPU"] = "DPU";
-    Incoterm["DAT"] = "DAT";
-    Incoterm["DDP"] = "DDP";
-})(Incoterm = exports.Incoterm || (exports.Incoterm = {}));

package/lib/models/digicust/invoice-type.model.d.ts

@@ -1,9 +0,0 @@
-import { Meta } from "..";
-export interface InvoiceType extends Meta<string> {
-    value?: "tax_invoice" | "proforma";
-    NC_24000?: string;
-    Dokumentenarten?: string;
-    DE_I0200?: string;
-    /** Bescheinigungsbereich */
-    DE_I0200_Bereich?: string;
-}

package/lib/models/digicust/invoice-type.model.js

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

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

@@ -1,62 +0,0 @@
-import { DigicustDocumentModel, IncotermModel, InvoiceType, LineItemModel, MeanOfTransportation, Package, TaxDetailsModel, TradePreference, TypeOfBusiness } from ".";
-import { AddressModel, CompanyModel, Currency, DateTimeModel, Dimensions, LanguageModel, Meta, Money, PackageType, Weight, WeightUnit } from "..";
-/**
- * Identifies an invoice
- */
-export interface InvoiceModel extends DigicustDocumentModel {
-    createdAt?: Date;
-    invoiceNumber?: Meta<string>;
-    waybillNumber?: Meta<string>;
-    invoiceType?: InvoiceType;
-    language?: LanguageModel;
-    invoiceDate?: DateTimeModel;
-    sellerOrderNumber?: Meta<string>;
-    buyerOrderNumber?: Meta<string>;
-    referenceNumber?: Meta<string>;
-    deliveryNote?: Meta<string>;
-    packingList?: Meta<string>;
-    meansOfTransportation?: MeanOfTransportation[];
-    typeOfBusiness?: TypeOfBusiness;
-    incoterm?: IncotermModel;
-    placeIncoterm?: AddressModel;
-    countryOfOrigin?: AddressModel;
-    generalHsCode?: Meta<string>;
-    generalGoodsDescription?: Meta<string>;
-    CAS?: Meta<string>;
-    dualUseApprovalNumber?: Meta<string>;
-    substanceCharacteristics?: Meta<string>;
-    intendedApplication?: Meta<string>;
-    tradePreference?: TradePreference;
-    preferenceInformation?: Meta<string>;
-    typeOfPackage?: PackageType;
-    weight?: Weight;
-    netWeight?: Weight;
-    weightUnit?: Meta<WeightUnit>;
-    packageDimensions?: Dimensions;
-    numberOfShipments?: Meta<number>;
-    packages?: Package[];
-    totalValueExcludingCharges?: Money;
-    totalValueWithoutTax?: Money;
-    totalTax?: Money;
-    licenseFee?: Money;
-    otherPayments?: Money;
-    shippingCost?: Money;
-    packagingCosts?: Money;
-    totalValue?: Money;
-    customsValue?: Money;
-    discount?: Money;
-    insuranceCosts?: Money;
-    currency?: Meta<Currency>;
-    taxDetails?: Array<TaxDetailsModel>;
-    paymentAccountNumber?: Meta<string>;
-    paymentBankCode?: Meta<string>;
-    paymentIBAN?: Meta<string>;
-    paymentBIC?: Meta<string>;
-    dueDate?: DateTimeModel;
-    items?: LineItemModel[];
-    itemIds?: string[];
-    shipper?: CompanyModel;
-    recipient?: CompanyModel;
-    consignee?: CompanyModel;
-    beneficiary?: CompanyModel;
-}

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

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

package/lib/models/digicust/masterdata/scoring-algorithm-type.enum.d.ts

@@ -1,5 +0,0 @@
-export declare enum ScoringAlgorithmType {
-    Exact = "exact",
-    JaroWrinkler = "jaro-wrinkler",
-    CosineSimilarity = "cosine-similarity"
-}

package/lib/models/digicust/masterdata/scoring-algorithm-type.enum.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScoringAlgorithmType = void 0;
-var ScoringAlgorithmType;
-(function (ScoringAlgorithmType) {
-    ScoringAlgorithmType["Exact"] = "exact";
-    ScoringAlgorithmType["JaroWrinkler"] = "jaro-wrinkler";
-    ScoringAlgorithmType["CosineSimilarity"] = "cosine-similarity";
-})(ScoringAlgorithmType = exports.ScoringAlgorithmType || (exports.ScoringAlgorithmType = {}));

package/lib/models/digicust/masterdata/stakeholder-matching-method.enum.d.ts

@@ -1,7 +0,0 @@
-export declare enum StakeholderMatchingMethod {
-    Unknown = 0,
-    EORI = 1,
-    VAT = 2,
-    NameAndCountry = 4,
-    FuzzyNameAndAddress = 8
-}

package/lib/models/digicust/masterdata/stakeholder-matching-method.enum.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StakeholderMatchingMethod = void 0;
-var StakeholderMatchingMethod;
-(function (StakeholderMatchingMethod) {
-    StakeholderMatchingMethod[StakeholderMatchingMethod["Unknown"] = 0] = "Unknown";
-    StakeholderMatchingMethod[StakeholderMatchingMethod["EORI"] = 1] = "EORI";
-    StakeholderMatchingMethod[StakeholderMatchingMethod["VAT"] = 2] = "VAT";
-    StakeholderMatchingMethod[StakeholderMatchingMethod["NameAndCountry"] = 4] = "NameAndCountry";
-    StakeholderMatchingMethod[StakeholderMatchingMethod["FuzzyNameAndAddress"] = 8] = "FuzzyNameAndAddress";
-})(StakeholderMatchingMethod = exports.StakeholderMatchingMethod || (exports.StakeholderMatchingMethod = {}));