digicust_types 1.7.0 → 1.7.5

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

@@ -1,15 +1,15 @@
-import { Meta } from "./meta";
-/**
- * Identifies a quantity of something (e.g. 5 kg)
- */
-export interface Quantity extends Meta<any> {
-    amount?: number;
-    /** Unit of measurement */
-    uom?: string;
-}
-export declare const condenseQuantity: (meta: Quantity) => {
-    amount: number | undefined;
-    uom: string | undefined;
-    confidence: number | undefined;
-    reviewNeeded: boolean | undefined;
-};
+import { Meta } from "./meta";
+/**
+ * Identifies a quantity of something (e.g. 5 kg)
+ */
+export interface Quantity extends Meta<any> {
+    amount?: number;
+    /** Unit of measurement */
+    uom?: string;
+}
+export declare const condenseQuantity: (meta: Quantity) => {
+    amount: number | undefined;
+    uom: string | undefined;
+    confidence: number | undefined;
+    reviewNeeded: boolean | undefined;
+};

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

@@ -1,10 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.condenseQuantity = void 0;
-var condenseQuantity = function (meta) { return ({
-    amount: meta.amount,
-    uom: meta.uom,
-    confidence: meta.confidence,
-    reviewNeeded: meta.reviewNeeded
-}); };
-exports.condenseQuantity = condenseQuantity;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.condenseQuantity = void 0;
+var condenseQuantity = function (meta) { return ({
+    amount: meta.amount,
+    uom: meta.uom,
+    confidence: meta.confidence,
+    reviewNeeded: meta.reviewNeeded
+}); };
+exports.condenseQuantity = condenseQuantity;

package/lib/models/common/section-type.enum.d.ts

@@ -1,10 +1,12 @@
-export declare enum SectionType {
-    type1 = "type1",
-    type2 = "type2",
-    type3 = "type3",
-    type4 = "type4",
-    type5 = "type5",
-    type6 = "type6",
-    type7 = "type7",
-    type8 = "type8"
-}
+export declare enum SectionType {
+    type1 = "type1",
+    type2 = "type2",
+    type3 = "type3",
+    type4 = "type4",
+    type5 = "type5",
+    type6 = "type6",
+    type7 = "type7",
+    type8 = "type8",
+    type9 = "type9",
+    type10 = "type10"
+}

package/lib/models/common/section-type.enum.js

@@ -1,14 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SectionType = void 0;
-var SectionType;
-(function (SectionType) {
-    SectionType["type1"] = "type1";
-    SectionType["type2"] = "type2";
-    SectionType["type3"] = "type3";
-    SectionType["type4"] = "type4";
-    SectionType["type5"] = "type5";
-    SectionType["type6"] = "type6";
-    SectionType["type7"] = "type7";
-    SectionType["type8"] = "type8";
-})(SectionType = exports.SectionType || (exports.SectionType = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SectionType = void 0;
+var SectionType;
+(function (SectionType) {
+    SectionType["type1"] = "type1";
+    SectionType["type2"] = "type2";
+    SectionType["type3"] = "type3";
+    SectionType["type4"] = "type4";
+    SectionType["type5"] = "type5";
+    SectionType["type6"] = "type6";
+    SectionType["type7"] = "type7";
+    SectionType["type8"] = "type8";
+    SectionType["type9"] = "type9";
+    SectionType["type10"] = "type10";
+})(SectionType = exports.SectionType || (exports.SectionType = {}));

package/lib/models/common/sort.enum.d.ts

@@ -1,4 +1,4 @@
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}

package/lib/models/common/sort.enum.js

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

package/lib/models/common/subscription-price.model.d.ts

@@ -1,9 +1,9 @@
-export interface SubscriptionPrice {
-    hsClassification: number;
-    dataExtraction: number;
-    dataNormalization: number;
-    dakosy: number;
-    upload: number;
-    ocr: number;
-    documentSplitting: number;
-}
+export interface SubscriptionPrice {
+    hsClassification: number;
+    dataExtraction: number;
+    dataNormalization: number;
+    dakosy: number;
+    upload: number;
+    ocr: number;
+    documentSplitting: number;
+}

package/lib/models/common/subscription-price.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/common/uom.enum.d.ts

@@ -1,39 +1,39 @@
-export declare enum UOM {
-    BG = "BG",
-    BA = "BA",
-    BT = "BT",
-    BOX = "BOX",
-    BH = "BH",
-    BE = "BE",
-    BU = "BU",
-    CI = "CI",
-    CT = "CT",
-    CS = "CS",
-    CM = "CM",
-    CON = "CON",
-    CR = "CR",
-    CY = "CY",
-    EA = "EA",
-    NMB = "NMB",
-    EN = "EN",
-    FT = "FT",
-    KG = "KG",
-    KGS = "KGS",
-    L = "L",
-    M = "M",
-    PK = "PK",
-    PA = "PA",
-    PAR = "PAR",
-    PRS = "PRS",
-    PAL = "PAL",
-    PC = "PC",
-    PCS = "PCS",
-    LB = "LB",
-    PF = "PF",
-    ROL = "ROL",
-    SET = "SET",
-    SME = "SME",
-    SYD = "SYD",
-    TU = "TU",
-    YD = "YD"
-}
+export declare enum UOM {
+    BG = "BG",
+    BA = "BA",
+    BT = "BT",
+    BOX = "BOX",
+    BH = "BH",
+    BE = "BE",
+    BU = "BU",
+    CI = "CI",
+    CT = "CT",
+    CS = "CS",
+    CM = "CM",
+    CON = "CON",
+    CR = "CR",
+    CY = "CY",
+    EA = "EA",
+    NMB = "NMB",
+    EN = "EN",
+    FT = "FT",
+    KG = "KG",
+    KGS = "KGS",
+    L = "L",
+    M = "M",
+    PK = "PK",
+    PA = "PA",
+    PAR = "PAR",
+    PRS = "PRS",
+    PAL = "PAL",
+    PC = "PC",
+    PCS = "PCS",
+    LB = "LB",
+    PF = "PF",
+    ROL = "ROL",
+    SET = "SET",
+    SME = "SME",
+    SYD = "SYD",
+    TU = "TU",
+    YD = "YD"
+}

package/lib/models/common/uom.enum.js

@@ -1,44 +1,44 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UOM = void 0;
-// UOM = Unit of Measurement Enum type
-var UOM;
-(function (UOM) {
-    UOM["BG"] = "BG";
-    UOM["BA"] = "BA";
-    UOM["BT"] = "BT";
-    UOM["BOX"] = "BOX";
-    UOM["BH"] = "BH";
-    UOM["BE"] = "BE";
-    UOM["BU"] = "BU";
-    UOM["CI"] = "CI";
-    UOM["CT"] = "CT";
-    UOM["CS"] = "CS";
-    UOM["CM"] = "CM";
-    UOM["CON"] = "CON";
-    UOM["CR"] = "CR";
-    UOM["CY"] = "CY";
-    UOM["EA"] = "EA";
-    UOM["NMB"] = "NMB";
-    UOM["EN"] = "EN";
-    UOM["FT"] = "FT";
-    UOM["KG"] = "KG";
-    UOM["KGS"] = "KGS";
-    UOM["L"] = "L";
-    UOM["M"] = "M";
-    UOM["PK"] = "PK";
-    UOM["PA"] = "PA";
-    UOM["PAR"] = "PAR";
-    UOM["PRS"] = "PRS";
-    UOM["PAL"] = "PAL";
-    UOM["PC"] = "PC";
-    UOM["PCS"] = "PCS";
-    UOM["LB"] = "LB";
-    UOM["PF"] = "PF";
-    UOM["ROL"] = "ROL";
-    UOM["SET"] = "SET";
-    UOM["SME"] = "SME";
-    UOM["SYD"] = "SYD";
-    UOM["TU"] = "TU";
-    UOM["YD"] = "YD";
-})(UOM = exports.UOM || (exports.UOM = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UOM = void 0;
+// UOM = Unit of Measurement Enum type
+var UOM;
+(function (UOM) {
+    UOM["BG"] = "BG";
+    UOM["BA"] = "BA";
+    UOM["BT"] = "BT";
+    UOM["BOX"] = "BOX";
+    UOM["BH"] = "BH";
+    UOM["BE"] = "BE";
+    UOM["BU"] = "BU";
+    UOM["CI"] = "CI";
+    UOM["CT"] = "CT";
+    UOM["CS"] = "CS";
+    UOM["CM"] = "CM";
+    UOM["CON"] = "CON";
+    UOM["CR"] = "CR";
+    UOM["CY"] = "CY";
+    UOM["EA"] = "EA";
+    UOM["NMB"] = "NMB";
+    UOM["EN"] = "EN";
+    UOM["FT"] = "FT";
+    UOM["KG"] = "KG";
+    UOM["KGS"] = "KGS";
+    UOM["L"] = "L";
+    UOM["M"] = "M";
+    UOM["PK"] = "PK";
+    UOM["PA"] = "PA";
+    UOM["PAR"] = "PAR";
+    UOM["PRS"] = "PRS";
+    UOM["PAL"] = "PAL";
+    UOM["PC"] = "PC";
+    UOM["PCS"] = "PCS";
+    UOM["LB"] = "LB";
+    UOM["PF"] = "PF";
+    UOM["ROL"] = "ROL";
+    UOM["SET"] = "SET";
+    UOM["SME"] = "SME";
+    UOM["SYD"] = "SYD";
+    UOM["TU"] = "TU";
+    UOM["YD"] = "YD";
+})(UOM = exports.UOM || (exports.UOM = {}));

package/lib/models/common/weight-unit.enum.d.ts

@@ -1,9 +1,9 @@
-export declare enum WeightUnit {
-    kilogram = "kg",
-    pound = "lb",
-    ounce = "ounce",
-    milligram = "mg",
-    gram = "g",
-    decagram = "dag",
-    ton = "t"
-}
+export declare enum WeightUnit {
+    kilogram = "kg",
+    pound = "lb",
+    ounce = "ounce",
+    milligram = "mg",
+    gram = "g",
+    decagram = "dag",
+    ton = "t"
+}

package/lib/models/common/weight-unit.enum.js

@@ -1,13 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WeightUnit = void 0;
-var WeightUnit;
-(function (WeightUnit) {
-    WeightUnit["kilogram"] = "kg";
-    WeightUnit["pound"] = "lb";
-    WeightUnit["ounce"] = "ounce";
-    WeightUnit["milligram"] = "mg";
-    WeightUnit["gram"] = "g";
-    WeightUnit["decagram"] = "dag";
-    WeightUnit["ton"] = "t";
-})(WeightUnit = exports.WeightUnit || (exports.WeightUnit = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WeightUnit = void 0;
+var WeightUnit;
+(function (WeightUnit) {
+    WeightUnit["kilogram"] = "kg";
+    WeightUnit["pound"] = "lb";
+    WeightUnit["ounce"] = "ounce";
+    WeightUnit["milligram"] = "mg";
+    WeightUnit["gram"] = "g";
+    WeightUnit["decagram"] = "dag";
+    WeightUnit["ton"] = "t";
+})(WeightUnit = exports.WeightUnit || (exports.WeightUnit = {}));

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

@@ -1,7 +1,7 @@
-import { WeightUnit } from "./weight-unit.enum";
-import { Meta } from "./meta";
-export interface Weight extends Meta<number> {
-    unit?: WeightUnit;
-    kgEquivalent?: number;
-}
-export declare const condenseWeight: (weight: Weight) => Weight;
+import { WeightUnit } from "./weight-unit.enum";
+import { Meta } from "./meta";
+export interface Weight extends Meta<number> {
+    unit?: WeightUnit;
+    kgEquivalent?: number;
+}
+export declare const condenseWeight: (weight: Weight) => Weight;

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

@@ -1,15 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.condenseWeight = void 0;
-var condenseWeight = function (weight) {
-    var condensed = {
-        value: weight.value,
-        unit: weight.unit,
-        kgEquivalent: weight.kgEquivalent,
-        confidence: weight.confidence,
-        reviewNeeded: weight.reviewNeeded,
-    };
-    condensed = JSON.parse(JSON.stringify(condensed)); // remove undefined properties
-    return condensed;
-};
-exports.condenseWeight = condenseWeight;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.condenseWeight = void 0;
+var condenseWeight = function (weight) {
+    var condensed = {
+        value: weight.value,
+        unit: weight.unit,
+        kgEquivalent: weight.kgEquivalent,
+        confidence: weight.confidence,
+        reviewNeeded: weight.reviewNeeded,
+    };
+    condensed = JSON.parse(JSON.stringify(condensed)); // remove undefined properties
+    return condensed;
+};
+exports.condenseWeight = condenseWeight;

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

@@ -1,12 +1,12 @@
-import { RossumImportStatus } from "../rossum";
-/**
- * Base Model for Analyser Metadata (used in case document)
- */
-export interface AnalyzerMetadataModel {
-    importStatus?: RossumImportStatus;
-    annotationId?: string;
-    queueId?: number;
-    exportOnConfirmed?: boolean;
-    splitAnnotationIds?: string[];
-    parentAnnotationId?: string;
-}
+import { RossumImportStatus } from "../rossum";
+/**
+ * Base Model for Analyser Metadata (used in case document)
+ */
+export interface AnalyzerMetadataModel {
+    importStatus?: RossumImportStatus;
+    annotationId?: string;
+    queueId?: number;
+    exportOnConfirmed?: boolean;
+    splitAnnotationIds?: string[];
+    parentAnnotationId?: string;
+}

package/lib/models/digicust/AnalyzerMetadataModel.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/activity.model.d.ts

@@ -1,16 +1,16 @@
-/**
- * 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;
-}
+/**
+ * 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;
+}

package/lib/models/digicust/activity.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/adjustment.model.d.ts

@@ -1,7 +1,7 @@
-import { Meta, Money } from "../common";
-/** adjustments to statistical/duty/VAT value */
-export interface Adjustment extends Meta<any> {
-    amountOfMoney?: Money;
-    valueType?: "Duty" | "Statistical" | "VAT";
-    type?: "Addition_Insurance" | "Addition_Transport" | "Addition_Further" | "Deduction_Insurance" | "Deduction_Transport" | "Deduction_Further";
-}
+import { Meta, Money } from "../common";
+/** adjustments to statistical/duty/VAT value */
+export interface Adjustment extends Meta<any> {
+    amountOfMoney?: Money;
+    valueType?: "Duty" | "Statistical" | "VAT";
+    type?: "Addition_Insurance" | "Addition_Transport" | "Addition_Further" | "Deduction_Insurance" | "Deduction_Transport" | "Deduction_Further";
+}

package/lib/models/digicust/adjustment.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/aggregated-case-data.model.d.ts

@@ -1,59 +1,64 @@
-import { Meta } from "../common/meta";
-import { AddressModel, CompanyModel, Currency, DateTimeModel, Money, Weight } from "../common";
-import { Incoterm } from "./incoterm.enum";
-import { LineItemModel } from "./line-item.model";
-import { WaybillType } from "./waybill.model";
-import { CaseType } from "./case-type.enum";
-import { LoadType } from "./load-type.enum";
-import { Adjustment } from "./adjustment.model";
-import { Container } from "./container.model";
-import { Package } from "./package.model";
-import { Procedure } from "./procedure.model";
-import { MeanOfTransportation } from "./mean-of-transportation.model";
-import { CustomsOffice } from "./customsOffice.model";
-import { TypeOfBusiness } from "./";
-/**
- * Used to store aggregated information of a case
- */
-export interface AggregatedCaseDataModel {
-    procedure?: Procedure;
-    /** commercial reference number, usually assigned by the trader */
-    referenceNumber?: Meta<string>;
-    /** Load Type, e.g. full container load */
-    loadType?: Meta<LoadType>;
-    countryOfOrigin?: AddressModel;
-    fromAddress?: AddressModel;
-    toAddress?: AddressModel;
-    arrivalDate?: DateTimeModel;
-    departureDate?: DateTimeModel;
-    consignee?: CompanyModel;
-    shipper?: CompanyModel;
-    exporter?: CompanyModel;
-    importer?: CompanyModel;
-    declarant?: CompanyModel;
-    agent?: CompanyModel;
-    broker?: CompanyModel;
-    buyer?: CompanyModel;
-    carrier?: CompanyModel;
-    warehouse?: CompanyModel;
-    /** adjustments to statistical/duty/VAT value */
-    adjustments?: Adjustment[];
-    containers?: Container[];
-    currency?: Meta<Currency>;
-    waybillType?: Meta<WaybillType>;
-    waybillNumber?: Meta<string>;
-    weight?: Weight;
-    netWeight?: Weight;
-    totalValue?: Money;
-    incoterm?: Meta<Incoterm>;
-    placeIncoterm?: AddressModel;
-    customsOffices?: CustomsOffice[];
-    meansOfTransportation?: MeanOfTransportation[];
-    typeofBusiness?: TypeOfBusiness;
-    /** case flow (import, export, ...) */
-    caseType?: Meta<CaseType>;
-    items?: LineItemModel[];
-    numberOfShipments?: Meta<number>;
-    packages?: Package[];
-}
-export declare const condenseAggregated: (aggregated?: AggregatedCaseDataModel | undefined) => AggregatedCaseDataModel | null;
+import { Meta } from "../common/meta";
+import { AddressModel, CompanyModel, Currency, DateTimeModel, Money, Weight } from "../common";
+import { Incoterm } from "./incoterm.enum";
+import { LineItemModel } from "./line-item.model";
+import { WaybillType } from "./waybill.model";
+import { CaseType } from "./case-type.enum";
+import { LoadType } from "./load-type.enum";
+import { Adjustment } from "./adjustment.model";
+import { Container } from "./container.model";
+import { Package } from "./package.model";
+import { Procedure } from "./procedure.model";
+import { MeanOfTransportation } from "./mean-of-transportation.model";
+import { CustomsOffice } from "./customsOffice.model";
+import { TypeOfBusiness } from "./";
+/**
+ * Used to store aggregated information of a case
+ */
+export interface AggregatedCaseDataModel {
+    procedure?: Procedure;
+    /** commercial reference number, usually assigned by the trader */
+    referenceNumber?: Meta<string>;
+    /** Load Type, e.g. full container load */
+    loadType?: Meta<LoadType>;
+    countryOfOrigin?: AddressModel;
+    fromAddress?: AddressModel;
+    toAddress?: AddressModel;
+    arrivalDate?: DateTimeModel;
+    departureDate?: DateTimeModel;
+    issueDate?: DateTimeModel;
+    transferDate?: DateTimeModel;
+    registrationDate?: DateTimeModel;
+    duration?: Meta<number>;
+    consignee?: CompanyModel;
+    shipper?: CompanyModel;
+    exporter?: CompanyModel;
+    importer?: CompanyModel;
+    declarant?: CompanyModel;
+    agent?: CompanyModel;
+    broker?: CompanyModel;
+    buyer?: CompanyModel;
+    carrier?: CompanyModel;
+    warehouse?: CompanyModel;
+    obligater?: CompanyModel;
+    /** adjustments to statistical/duty/VAT value */
+    adjustments?: Adjustment[];
+    containers?: Container[];
+    currency?: Meta<Currency>;
+    waybillType?: Meta<WaybillType>;
+    waybillNumber?: Meta<string>;
+    weight?: Weight;
+    netWeight?: Weight;
+    totalValue?: Money;
+    incoterm?: Meta<Incoterm>;
+    placeIncoterm?: AddressModel;
+    customsOffices?: CustomsOffice[];
+    meansOfTransportation?: MeanOfTransportation[];
+    typeofBusiness?: TypeOfBusiness;
+    /** case flow (import, export, ...) */
+    caseType?: Meta<CaseType>;
+    items?: LineItemModel[];
+    numberOfShipments?: Meta<number>;
+    packages?: Package[];
+}
+export declare const condenseAggregated: (aggregated?: AggregatedCaseDataModel | undefined) => AggregatedCaseDataModel | null;