digicust_types 1.7.154 → 1.7.155

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

@@ -1,62 +1,62 @@
-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;
-}
+import { DigicustDocumentModel, IncotermModel, InvoiceType, LineItemModel, MeanOfTransportation, Package, TaxDetailsModel, TradePreference, TypeOfBusiness } from ".";
+import { AddressModel, CompanyModel, Currency, DateTimeModel, Dimensions, LanguageModel, Meta, Money, PackageType, Weight } 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<string>;
+    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 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/models/digicust/line-item.model.d.ts

@@ -1,78 +1,78 @@
-import { Adjustment, Container, DigicustDocumentModel, DocumentTypeCode, Package, PreferenceState, Procedure } from ".";
-import { AddressModel, CompanyModel, Currency, CustomsTariffNumber, Meta, Money, Quantity, UOM, Weight, WeightUnit } from "..";
-import { Bbox } from "../common/bbox.model";
-/**
- * Identifies line items (specific products) listed on a document
- */
-export interface LineItemModel {
-    id?: string;
-    documentId?: string;
-    caseId?: string;
-    isCondensed?: boolean;
-    invoiceNumber?: Meta<string>;
-    waybillNumber?: Meta<string>;
-    transitNumber?: Meta<string>;
-    box40?: Meta<string>;
-    guaranteeNumber?: Meta<string>;
-    billOfLading?: Meta<string>;
-    customsTariffNumber?: CustomsTariffNumber;
-    discountText?: string;
-    position?: Meta<string>;
-    code?: Meta<string>;
-    hsCode?: Meta<string>;
-    batchNumber?: Meta<string>;
-    lotNumber?: Meta<string>;
-    serialNumber?: Meta<string>;
-    orderNumber?: Meta<string>;
-    description?: Meta<string>;
-    documentDescription?: Meta<string>;
-    quantity?: Quantity;
-    orderedQuantity?: Quantity;
-    unitOfMeasurement?: Meta<UOM>;
-    countryOfOrigin?: AddressModel;
-    itemValue?: Money;
-    totalValue?: Money;
-    totalValueExcludingCharges?: Money;
-    customsValue?: Money;
-    amountUnit?: Meta<number>;
-    discount?: Money;
-    discountUnit?: Meta<Currency>;
-    currency?: Meta<Currency>;
-    netWeight?: Weight;
-    totalNetWeight?: Weight;
-    grossWeight?: Weight;
-    totalGrossWeight?: Weight;
-    weightUnit?: Meta<WeightUnit>;
-    itemSize?: Meta<string>;
-    itemSpecialUnitMeasure?: Meta<number>;
-    itemSpecialUnit?: Meta<string>;
-    buyerArticleNumber?: Meta<string>;
-    buyerOrderNumber?: Meta<string>;
-    /** Textual Material Description */
-    material?: Meta<string>;
-    materialNumber?: Meta<string>;
-    CAS?: Meta<string>;
-    deliveryNote?: Meta<string>;
-    reference?: Meta<string>;
-    packingList?: Meta<string>;
-    units?: {
-        number?: number;
-        type?: string;
-    }[];
-    preferenceState?: PreferenceState;
-    documents?: DigicustDocumentModel[];
-    adjustments?: Adjustment[];
-    containers?: Container[];
-    /** export declaration **/
-    shipper: CompanyModel;
-    exportingCountry: AddressModel;
-    destinationCountry: AddressModel;
-    customsProcedure: Procedure;
-    documentTypes: DocumentTypeCode[];
-    preliminaryDocument: Meta<string>;
-    specialRemarks: Meta<string>[];
-    packages?: Package[];
-    materialId?: string;
-    bbox?: Bbox;
-}
-export declare const condenseLineItem: (lineItem?: LineItemModel | undefined) => LineItemModel | null;
+import { Adjustment, Container, DigicustDocumentModel, DocumentTypeCode, Package, PreferenceState, Procedure } from ".";
+import { AddressModel, CompanyModel, Currency, CustomsTariffNumber, Meta, Money, Quantity, UOM, Weight, WeightUnit } from "..";
+import { Bbox } from "../common/bbox.model";
+/**
+ * Identifies line items (specific products) listed on a document
+ */
+export interface LineItemModel {
+    id?: string;
+    documentId?: string;
+    caseId?: string;
+    isCondensed?: boolean;
+    invoiceNumber?: Meta<string>;
+    waybillNumber?: Meta<string>;
+    transitNumber?: Meta<string>;
+    box40?: Meta<string>;
+    guaranteeNumber?: Meta<string>;
+    billOfLading?: Meta<string>;
+    customsTariffNumber?: CustomsTariffNumber;
+    discountText?: string;
+    position?: Meta<string>;
+    code?: Meta<string>;
+    hsCode?: Meta<string>;
+    batchNumber?: Meta<string>;
+    lotNumber?: Meta<string>;
+    serialNumber?: Meta<string>;
+    orderNumber?: Meta<string>;
+    description?: Meta<string>;
+    documentDescription?: Meta<string>;
+    quantity?: Quantity;
+    orderedQuantity?: Quantity;
+    unitOfMeasurement?: Meta<UOM>;
+    countryOfOrigin?: AddressModel;
+    itemValue?: Money;
+    totalValue?: Money;
+    totalValueExcludingCharges?: Money;
+    customsValue?: Money;
+    amountUnit?: Meta<number>;
+    discount?: Money;
+    discountUnit?: Meta<Currency>;
+    currency?: Meta<Currency>;
+    netWeight?: Weight;
+    totalNetWeight?: Weight;
+    grossWeight?: Weight;
+    totalGrossWeight?: Weight;
+    weightUnit?: Meta<WeightUnit>;
+    itemSize?: Meta<string>;
+    itemSpecialUnitMeasure?: Meta<number>;
+    itemSpecialUnit?: Meta<string>;
+    buyerArticleNumber?: Meta<string>;
+    buyerOrderNumber?: Meta<string>;
+    /** Textual Material Description */
+    material?: Meta<string>;
+    materialNumber?: Meta<string>;
+    CAS?: Meta<string>;
+    deliveryNote?: Meta<string>;
+    reference?: Meta<string>;
+    packingList?: Meta<string>;
+    units?: {
+        number?: number;
+        type?: string;
+    }[];
+    preferenceState?: PreferenceState;
+    documents?: DigicustDocumentModel[];
+    adjustments?: Adjustment[];
+    containers?: Container[];
+    /** export declaration **/
+    shipper: CompanyModel;
+    exportingCountry: AddressModel;
+    destinationCountry: AddressModel;
+    customsProcedure: Procedure;
+    documentTypes: DocumentTypeCode[];
+    preliminaryDocument: Meta<string>;
+    specialRemarks: Meta<string>[];
+    packages?: Package[];
+    materialId?: string;
+    bbox?: Bbox;
+}
+export declare const condenseLineItem: (lineItem?: LineItemModel | undefined) => LineItemModel | null;

package/lib/models/digicust/line-item.model.js

@@ -1,17 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.condenseLineItem = void 0;
-var cleanObject_1 = require("../../helpers/cleanObject");
-var condenseLineItem = function (lineItem) {
-    if (lineItem) {
-        var condensedLineItem = {
-            id: lineItem.id,
-            documentId: lineItem.documentId,
-            caseId: lineItem.caseId,
-        };
-        (0, cleanObject_1.cleanObject)(condensedLineItem);
-        return condensedLineItem;
-    }
-    return null;
-};
-exports.condenseLineItem = condenseLineItem;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.condenseLineItem = void 0;
+var cleanObject_1 = require("../../helpers/cleanObject");
+var condenseLineItem = function (lineItem) {
+    if (lineItem) {
+        var condensedLineItem = {
+            id: lineItem.id,
+            documentId: lineItem.documentId,
+            caseId: lineItem.caseId,
+        };
+        (0, cleanObject_1.cleanObject)(condensedLineItem);
+        return condensedLineItem;
+    }
+    return null;
+};
+exports.condenseLineItem = condenseLineItem;

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

@@ -1,14 +1,14 @@
-export declare enum LoadType {
-    /** Courier Express and Parcel */
-    CEP = "CEP",
-    /** Full Container Load	 */
-    FCL = "FCL",
-    /** Less-Than-Container Load	 */
-    LCL = "LCL",
-    /** Full Truck Load */
-    FTL = "FTL",
-    /** Less-Than-Truck Load	 */
-    LTL = "LTL",
-    /** Bulk Cargo	 */
-    Bulk = "Bulk"
-}
+export declare enum LoadType {
+    /** Courier Express and Parcel */
+    CEP = "CEP",
+    /** Full Container Load	 */
+    FCL = "FCL",
+    /** Less-Than-Container Load	 */
+    LCL = "LCL",
+    /** Full Truck Load */
+    FTL = "FTL",
+    /** Less-Than-Truck Load	 */
+    LTL = "LTL",
+    /** Bulk Cargo	 */
+    Bulk = "Bulk"
+}

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

@@ -1,19 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LoadType = void 0;
-// Load type - e.g. full container load
-var LoadType;
-(function (LoadType) {
-    /** Courier Express and Parcel */
-    LoadType["CEP"] = "CEP";
-    /** Full Container Load	 */
-    LoadType["FCL"] = "FCL";
-    /** Less-Than-Container Load	 */
-    LoadType["LCL"] = "LCL";
-    /** Full Truck Load */
-    LoadType["FTL"] = "FTL";
-    /** Less-Than-Truck Load	 */
-    LoadType["LTL"] = "LTL";
-    /** Bulk Cargo	 */
-    LoadType["Bulk"] = "Bulk";
-})(LoadType = exports.LoadType || (exports.LoadType = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoadType = void 0;
+// Load type - e.g. full container load
+var LoadType;
+(function (LoadType) {
+    /** Courier Express and Parcel */
+    LoadType["CEP"] = "CEP";
+    /** Full Container Load	 */
+    LoadType["FCL"] = "FCL";
+    /** Less-Than-Container Load	 */
+    LoadType["LCL"] = "LCL";
+    /** Full Truck Load */
+    LoadType["FTL"] = "FTL";
+    /** Less-Than-Truck Load	 */
+    LoadType["LTL"] = "LTL";
+    /** Bulk Cargo	 */
+    LoadType["Bulk"] = "Bulk";
+})(LoadType = exports.LoadType || (exports.LoadType = {}));

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

@@ -1,7 +1,7 @@
-export * from "./material.model";
-export * from "./stakeholder.model";
-export * from "./stakeholder-role.enum";
-export * from "./user-edited-properties.type";
-export * from "./matching-metadata.model";
-export * from "./scoring-algorithm-type.enum";
-export * from "./stakeholder-matching-method.enum";
+export * from "./material.model";
+export * from "./stakeholder.model";
+export * from "./stakeholder-role.enum";
+export * from "./user-edited-properties.type";
+export * from "./matching-metadata.model";
+export * from "./string-scoring-algorithm-type.enum";
+export * from "./stakeholder-matching-method.enum";

package/lib/models/digicust/masterdata/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;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (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("./material.model"), exports);
-__exportStar(require("./stakeholder.model"), exports);
-__exportStar(require("./stakeholder-role.enum"), exports);
-__exportStar(require("./user-edited-properties.type"), exports);
-__exportStar(require("./matching-metadata.model"), exports);
-__exportStar(require("./scoring-algorithm-type.enum"), exports);
-__exportStar(require("./stakeholder-matching-method.enum"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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("./material.model"), exports);
+__exportStar(require("./stakeholder.model"), exports);
+__exportStar(require("./stakeholder-role.enum"), exports);
+__exportStar(require("./user-edited-properties.type"), exports);
+__exportStar(require("./matching-metadata.model"), exports);
+__exportStar(require("./string-scoring-algorithm-type.enum"), exports);
+__exportStar(require("./stakeholder-matching-method.enum"), exports);

package/lib/models/digicust/masterdata/matching-metadata.model.d.ts

@@ -1,11 +1,16 @@
-import { ScoringAlgorithmType } from './scoring-algorithm-type.enum';
-export interface MatchingMetadataModel<T> {
-    method: T;
-    input: {
-        [key: string]: string;
-    };
-    scoringAlgorithm: ScoringAlgorithmType;
-    scoringResult: {
-        [key: string]: number;
-    };
-}
+import { StringScoringAlgorithmType } from './string-scoring-algorithm-type.enum';
+export interface MatchingMetadataModel<T> {
+    input: {
+        [key: string]: string;
+    };
+    scoringAlgorithm: string;
+    matchScore: number;
+    matchedMethodFlags: T;
+    detailMatches?: {
+        [key: string]: {
+            scoringAlgorithm: StringScoringAlgorithmType;
+            matchScore: number;
+            matchValue: string;
+        };
+    };
+}

package/lib/models/digicust/masterdata/matching-metadata.model.js

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