digicust_types 1.7.162 → 1.7.166

package/lib/models/digicust/documents/index.js

@@ -1,27 +1,28 @@
-"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 });
-// Invoice
-__exportStar(require("./invoice-type.model"), exports);
-__exportStar(require("./invoice.model"), exports);
-// Packing List
-__exportStar(require("./packing-list.model"), exports);
-// Waybill
-__exportStar(require("./waybill-type.model"), exports);
-__exportStar(require("./waybill.model"), exports);
-// customs declarations
-__exportStar(require("./export-declaration.model"), exports);
-__exportStar(require("./custom-document.model"), exports);
-__exportStar(require("./digicust-document.model"), exports);
-__exportStar(require("./digicust-document-type.enum"), exports);
-__exportStar(require("./document-status.enum"), exports);
-__exportStar(require("./document-code.model"), 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 });
+// Invoice
+__exportStar(require("./invoice-type.model"), exports);
+__exportStar(require("./invoice.model"), exports);
+// Packing List
+__exportStar(require("./packing-list.model"), exports);
+// Waybill
+__exportStar(require("./waybill-type.model"), exports);
+__exportStar(require("./waybill.model"), exports);
+// customs declarations
+__exportStar(require("./export-declaration.model"), exports);
+__exportStar(require("./custom-document.model"), exports);
+__exportStar(require("./digicust-document.model"), exports);
+__exportStar(require("./digicust-document-type.enum"), exports);
+__exportStar(require("./document-status.enum"), exports);
+__exportStar(require("./document-code.model"), exports);
+__exportStar(require("./line-item-containing-document"), exports);

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

@@ -1,9 +1,9 @@
-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;
-}
+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/documents/invoice-type.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/documents/invoice.model.d.ts

@@ -1,62 +1,61 @@
-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, MeanOfTransportation, Package, TaxDetailsModel, TradePreference, TypeOfBusiness } from "../";
+import { AddressModel, CompanyModel, Currency, DateTimeModel, Dimensions, LanguageModel, Meta, Money, PackageType, Weight, WeightUnit } from "../../";
+import { LineItemContainingDocument } from './line-item-containing-document';
+/**
+ * Identifies an invoice
+ */
+export interface InvoiceModel extends DigicustDocumentModel, LineItemContainingDocument {
+    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;
+    shipper?: CompanyModel;
+    recipient?: CompanyModel;
+    consignee?: CompanyModel;
+    beneficiary?: CompanyModel;
+}

package/lib/models/digicust/documents/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/documents/line-item-containing-document.d.ts

@@ -0,0 +1,6 @@
+import { LineItemModel } from '../line-item.model';
+export interface LineItemContainingDocument {
+    id?: string;
+    items?: LineItemModel[];
+    itemIds?: string[];
+}

package/lib/models/digicust/documents/line-item-containing-document.js

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

package/lib/models/digicust/documents/packing-list.model.d.ts

@@ -1,33 +1,33 @@
-import { CompanyModel, Currency, DateTimeModel, Dimensions, LanguageModel, Meta, Money, PackageType, Weight } from "../../common";
-import { DigicustDocumentModel } from "./digicust-document.model";
-import { LineItemModel } from "../line-item.model";
-export interface PackingListModel extends DigicustDocumentModel {
-    shipper?: CompanyModel;
-    invoiceRecipient?: CompanyModel;
-    consignee?: CompanyModel;
-    language?: LanguageModel;
-    packingListNumber?: Meta<string>;
-    issueDate?: DateTimeModel;
-    invoiceNumber?: Meta<string>;
-    sellerOrderNumber?: Meta<string>;
-    buyerOrderNumber?: Meta<string>;
-    referenceNumber?: Meta<string>;
-    waybillNumber?: Meta<string>;
-    deliveryNote?: Meta<string>;
-    totalGrossWeight?: Weight;
-    totalNetWeight?: Weight;
-    typeOfPackage?: PackageType;
-    packageDimensions?: Dimensions;
-    amountOfPackages?: Meta<Number>;
-    totalExcludingCharges?: Money;
-    insuranceCosts?: Money;
-    packagingCosts?: Money;
-    discount?: Money;
-    licenseFee?: Money;
-    otherPayments?: Money;
-    shippingCosts?: Money;
-    totalValue?: Money;
-    customsValue?: Money;
-    currency?: Meta<Currency>;
-    items?: LineItemModel[];
-}
+import { CompanyModel, Currency, DateTimeModel, Dimensions, LanguageModel, Meta, Money, PackageType, Weight } from "../../common";
+import { DigicustDocumentModel } from "./digicust-document.model";
+import { LineItemModel } from "../line-item.model";
+export interface PackingListModel extends DigicustDocumentModel {
+    shipper?: CompanyModel;
+    invoiceRecipient?: CompanyModel;
+    consignee?: CompanyModel;
+    language?: LanguageModel;
+    packingListNumber?: Meta<string>;
+    issueDate?: DateTimeModel;
+    invoiceNumber?: Meta<string>;
+    sellerOrderNumber?: Meta<string>;
+    buyerOrderNumber?: Meta<string>;
+    referenceNumber?: Meta<string>;
+    waybillNumber?: Meta<string>;
+    deliveryNote?: Meta<string>;
+    totalGrossWeight?: Weight;
+    totalNetWeight?: Weight;
+    typeOfPackage?: PackageType;
+    packageDimensions?: Dimensions;
+    amountOfPackages?: Meta<Number>;
+    totalExcludingCharges?: Money;
+    insuranceCosts?: Money;
+    packagingCosts?: Money;
+    discount?: Money;
+    licenseFee?: Money;
+    otherPayments?: Money;
+    shippingCosts?: Money;
+    totalValue?: Money;
+    customsValue?: Money;
+    currency?: Meta<Currency>;
+    items?: LineItemModel[];
+}

package/lib/models/digicust/documents/packing-list.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/documents/waybill-type.model.d.ts

@@ -1,15 +1,15 @@
-import { Meta } from "../..";
-export interface WaybillTypeModel extends Meta<WaybillType> {
-    NC_24000?: string;
-    Dokumentenarten?: string;
-    DE_I0200?: string;
-    /** Bescheinigungsbereich */
-    DE_I0200_Bereich?: string;
-}
-export declare enum WaybillType {
-    airWaybill = "airWaybill",
-    seaWaybill = "seaWaybill",
-    railWaybill = "railWaybill",
-    roadWaybill = "roadWaybill",
-    inlandShippingWaybill = "inlandShippingWaybill"
-}
+import { Meta } from "../..";
+export interface WaybillTypeModel extends Meta<WaybillType> {
+    NC_24000?: string;
+    Dokumentenarten?: string;
+    DE_I0200?: string;
+    /** Bescheinigungsbereich */
+    DE_I0200_Bereich?: string;
+}
+export declare enum WaybillType {
+    airWaybill = "airWaybill",
+    seaWaybill = "seaWaybill",
+    railWaybill = "railWaybill",
+    roadWaybill = "roadWaybill",
+    inlandShippingWaybill = "inlandShippingWaybill"
+}

package/lib/models/digicust/documents/waybill-type.model.js

@@ -1,11 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WaybillType = void 0;
-var WaybillType;
-(function (WaybillType) {
-    WaybillType["airWaybill"] = "airWaybill";
-    WaybillType["seaWaybill"] = "seaWaybill";
-    WaybillType["railWaybill"] = "railWaybill";
-    WaybillType["roadWaybill"] = "roadWaybill";
-    WaybillType["inlandShippingWaybill"] = "inlandShippingWaybill";
-})(WaybillType = exports.WaybillType || (exports.WaybillType = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WaybillType = void 0;
+var WaybillType;
+(function (WaybillType) {
+    WaybillType["airWaybill"] = "airWaybill";
+    WaybillType["seaWaybill"] = "seaWaybill";
+    WaybillType["railWaybill"] = "railWaybill";
+    WaybillType["roadWaybill"] = "roadWaybill";
+    WaybillType["inlandShippingWaybill"] = "inlandShippingWaybill";
+})(WaybillType = exports.WaybillType || (exports.WaybillType = {}));

package/lib/models/digicust/documents/waybill.model.d.ts

@@ -1,33 +1,33 @@
-import { AddressModel, CompanyModel, Currency, DateTimeModel, Money, Weight } from "../../common";
-import { DigicustDocumentModel } from "./";
-import { Meta } from "../../common/meta";
-import { IncotermModel } from "../incoterm.model";
-import { Package } from "../package.model";
-import { WaybillTypeModel } from "./waybill-type.model";
-/**
- * Identifies a waybill document
- */
-export interface WaybillModel extends DigicustDocumentModel {
-    shipper?: CompanyModel;
-    recipient?: CompanyModel;
-    consignee?: CompanyModel;
-    applicant?: CompanyModel;
-    waybillNumber?: Meta<string>;
-    issueDate?: DateTimeModel;
-    waybillType?: WaybillTypeModel;
-    referenceNumber?: Meta<string>;
-    weight?: Weight;
-    totalValue?: Money;
-    totalValueExcludingCharges?: Money;
-    customsValue?: Money;
-    shippingCost?: Money;
-    otherPayments?: Money;
-    shippingDate?: DateTimeModel;
-    incoterm?: IncotermModel;
-    placeIncoterm?: AddressModel;
-    invoiceNumber?: Meta<string>;
-    goodsDescription?: Meta<string>;
-    currency?: Meta<Currency>;
-    numPackagesShipped?: Meta<number>;
-    packages?: Package[];
-}
+import { AddressModel, CompanyModel, Currency, DateTimeModel, Money, Weight } from "../../common";
+import { DigicustDocumentModel } from "./";
+import { Meta } from "../../common/meta";
+import { IncotermModel } from "../incoterm.model";
+import { Package } from "../package.model";
+import { WaybillTypeModel } from "./waybill-type.model";
+/**
+ * Identifies a waybill document
+ */
+export interface WaybillModel extends DigicustDocumentModel {
+    shipper?: CompanyModel;
+    recipient?: CompanyModel;
+    consignee?: CompanyModel;
+    applicant?: CompanyModel;
+    waybillNumber?: Meta<string>;
+    issueDate?: DateTimeModel;
+    waybillType?: WaybillTypeModel;
+    referenceNumber?: Meta<string>;
+    weight?: Weight;
+    totalValue?: Money;
+    totalValueExcludingCharges?: Money;
+    customsValue?: Money;
+    shippingCost?: Money;
+    otherPayments?: Money;
+    shippingDate?: DateTimeModel;
+    incoterm?: IncotermModel;
+    placeIncoterm?: AddressModel;
+    invoiceNumber?: Meta<string>;
+    goodsDescription?: Meta<string>;
+    currency?: Meta<Currency>;
+    numPackagesShipped?: Meta<number>;
+    packages?: Package[];
+}

package/lib/models/digicust/documents/waybill.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/errors.model.d.ts

@@ -1,8 +1,8 @@
-export interface ValidationError extends Error {
-    type: "ValidationError";
-    severity?: "error" | "warning" | "info";
-    field?: string;
-    expected?: any;
-    actual?: any;
-    reference?: string;
-}
+export interface ValidationError extends Error {
+    type: "ValidationError";
+    severity?: "error" | "warning" | "info";
+    field?: string;
+    expected?: any;
+    actual?: any;
+    reference?: string;
+}

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

@@ -1,59 +1,59 @@
-/**
- * Base model of an event (e.g. webhook or email)
- */
-export interface Event {
-    checkpoint?: string;
-    suppressMultipleExecutions?: boolean;
-    type?: EventType;
-}
-export declare enum EventType {
-    webhook = "webhook",
-    mail = "email",
-    sftp = "sftp",
-    mountedSFTP = "mountedSFTP"
-}
-export interface WebhookEvent extends Event {
-    type: EventType.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 SFTPEvent extends Event {
-    type: EventType.sftp;
-    /** How to map the data */
-    caseFileMapping: CaseFileMapping;
-    "sftp-password": string;
-    "sftp-login-name": string;
-    "sftp-port": string;
-    "sftp-dns-name": string;
-    "sftp-path": string;
-}
-export interface EmailEvent extends Event {
-    type: EventType.mail;
-    emailAddress?: string;
-    body?: any;
-    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
-    bodyMapping?: string;
-    attachDocuments?: {
-        active?: boolean;
-    };
-    attachCase?: {
-        active?: boolean;
-    } & CaseFileMapping;
-}
-export interface CaseFileMapping {
-    format?: "JSON" | "CSV" | "XML" | "TXT";
-    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
-    fileNameMapping?: string;
-    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
-    mapping?: string;
-    /** Delimiter for CSV mapping */
-    csvSeparator?: string;
-    /** Include headers in CSV */
-    includeHeaders?: boolean;
-    /** Remove non-latin symbols */
-    removeAccents?: boolean;
-}
+/**
+ * Base model of an event (e.g. webhook or email)
+ */
+export interface Event {
+    checkpoint?: string;
+    suppressMultipleExecutions?: boolean;
+    type?: EventType;
+}
+export declare enum EventType {
+    webhook = "webhook",
+    mail = "email",
+    sftp = "sftp",
+    mountedSFTP = "mountedSFTP"
+}
+export interface WebhookEvent extends Event {
+    type: EventType.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 SFTPEvent extends Event {
+    type: EventType.sftp;
+    /** How to map the data */
+    caseFileMapping: CaseFileMapping;
+    "sftp-password": string;
+    "sftp-login-name": string;
+    "sftp-port": string;
+    "sftp-dns-name": string;
+    "sftp-path": string;
+}
+export interface EmailEvent extends Event {
+    type: EventType.mail;
+    emailAddress?: string;
+    body?: any;
+    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
+    bodyMapping?: string;
+    attachDocuments?: {
+        active?: boolean;
+    };
+    attachCase?: {
+        active?: boolean;
+    } & CaseFileMapping;
+}
+export interface CaseFileMapping {
+    format?: "JSON" | "CSV" | "XML" | "TXT";
+    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
+    fileNameMapping?: string;
+    /** mapping in JSONATA format (https://www.npmjs.com/package/jsonata) */
+    mapping?: string;
+    /** Delimiter for CSV mapping */
+    csvSeparator?: string;
+    /** Include headers in CSV */
+    includeHeaders?: boolean;
+    /** Remove non-latin symbols */
+    removeAccents?: boolean;
+}

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

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