digicust_types 1.7.103 → 1.7.104

package/lib/models/digicust/index.js

@@ -1,69 +1,69 @@
-"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 });
-// Customs Case Specific Interfaces
-__exportStar(require("./case.model"), exports); // basic model for customs cases
-__exportStar(require("./case-status.enum"), exports); // provides information about the case status
-__exportStar(require("./case-type.enum"), exports); // provides information about the type of customs case
-__exportStar(require("./aggregated-case-data.model"), exports); // provides aggregated information about the customs case
-__exportStar(require("./stats-case.model"), exports); // statistics about the case
-__exportStar(require("./procedure.model"), exports); // customs procedure
-__exportStar(require("./project.model"), exports);
-// Case Submission
-__exportStar(require("./case-submission-transaction"), exports); // statistics about the case
-__exportStar(require("./operationType.enum"), exports); // statistics about the case
-// Customs Documents
-__exportStar(require("./digicust-document.model"), exports); // base model for customs documents (eg. waybills, invoices, ...)
-__exportStar(require("./digicust-document-type.enum"), exports); // document types
-__exportStar(require("./document-status.enum"), exports); // provides information about the status of the case
-__exportStar(require("./invoice.model"), exports); // invoice document model -> inherits from digicust-document.model
-__exportStar(require("./waybill.model"), exports); // waybill document model -> inherits from digicust-document.model
-__exportStar(require("./packingList.model"), exports);
-__exportStar(require("./document-code.model"), exports);
-__exportStar(require("./line-item.model"), exports); // line items of customs documents
-__exportStar(require("./tax-details.model"), exports); // Information about VAT on a document
-__exportStar(require("./uploaded-file.model"), exports); // Uploaded files of customs documents
-__exportStar(require("./consignment-size.enum"), exports); // Consignment size
-__exportStar(require("./special-measure.model"), exports); // special measures
-__exportStar(require("./incoterm.model"), exports); // shipping conditions
-__exportStar(require("./load-type.enum"), exports); // load type information
-__exportStar(require("./adjustment.model"), exports); // classification
-__exportStar(require("./container.model"), exports); // container
-__exportStar(require("./package.model"), exports); // Package
-__exportStar(require("./mean-of-transportation.model"), exports); // mean of transportation
-__exportStar(require("./customsOffice.model"), exports); // customs office model
-__exportStar(require("./type-of-business.enum"), exports);
-__exportStar(require("./type-of-business.model"), exports);
-__exportStar(require("./cost-intersection.model"), exports); // cost intersection
-__exportStar(require("./preference-state.model"), exports); // preferential origin
-__exportStar(require("./invoice-type.model"), exports); // either proforma or tax invoice
-__exportStar(require("./waybill-type.model"), exports); // waybill types
-// Digicust Customers and Users
-__exportStar(require("./customer.model"), exports); // Customer information
-__exportStar(require("./user.model"), exports); // User information
-// Workflow Specific Interfaces
-__exportStar(require("./activity.model"), exports); // tracks activities, used for billing and eventually process mining
-__exportStar(require("./context.model"), exports); // context of a case (not actively used)
-__exportStar(require("./event.model"), exports); // Base model of an event (e.g. webhook or email)
-__exportStar(require("./execution-strategy.model"), exports); // Execution strategies are customer-configurable plans on how to process a specific case.
-__exportStar(require("./module.model"), exports); //  Identifies a module. Modules are different "programs" in the frontend
-__exportStar(require("./errors.model"), exports); // For conceptualizing eg. validation errors
-__exportStar(require("./report.model"), exports); // not actively used
-// HS Codes
-__exportStar(require("./hs-code-mapping"), exports); // mappings from goods descriptions etc. to hs codes
-// Frontend
-__exportStar(require("./frontend-mapping.model"), exports);
-__exportStar(require("./queue.model"), exports);
-__exportStar(require("./masterdata"), exports);
-__exportStar(require("./extractions"), exports);
-// membership
-__exportStar(require("./membership.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 });
+// Customs Case Specific Interfaces
+__exportStar(require("./case.model"), exports); // basic model for customs cases
+__exportStar(require("./case-status.enum"), exports); // provides information about the case status
+__exportStar(require("./case-type.enum"), exports); // provides information about the type of customs case
+__exportStar(require("./aggregated-case-data.model"), exports); // provides aggregated information about the customs case
+__exportStar(require("./stats-case.model"), exports); // statistics about the case
+__exportStar(require("./procedure.model"), exports); // customs procedure
+__exportStar(require("./project.model"), exports);
+// Case Submission
+__exportStar(require("./case-submission-transaction"), exports); // statistics about the case
+__exportStar(require("./operationType.enum"), exports); // statistics about the case
+// Customs Documents
+__exportStar(require("./digicust-document.model"), exports); // base model for customs documents (eg. waybills, invoices, ...)
+__exportStar(require("./digicust-document-type.enum"), exports); // document types
+__exportStar(require("./document-status.enum"), exports); // provides information about the status of the case
+__exportStar(require("./invoice.model"), exports); // invoice document model -> inherits from digicust-document.model
+__exportStar(require("./waybill.model"), exports); // waybill document model -> inherits from digicust-document.model
+__exportStar(require("./packingList.model"), exports);
+__exportStar(require("./document-code.model"), exports);
+__exportStar(require("./line-item.model"), exports); // line items of customs documents
+__exportStar(require("./tax-details.model"), exports); // Information about VAT on a document
+__exportStar(require("./uploaded-file.model"), exports); // Uploaded files of customs documents
+__exportStar(require("./consignment-size.enum"), exports); // Consignment size
+__exportStar(require("./special-measure.model"), exports); // special measures
+__exportStar(require("./incoterm.model"), exports); // shipping conditions
+__exportStar(require("./load-type.enum"), exports); // load type information
+__exportStar(require("./adjustment.model"), exports); // classification
+__exportStar(require("./container.model"), exports); // container
+__exportStar(require("./package.model"), exports); // Package
+__exportStar(require("./mean-of-transportation.model"), exports); // mean of transportation
+__exportStar(require("./customsOffice.model"), exports); // customs office model
+__exportStar(require("./type-of-business.enum"), exports);
+__exportStar(require("./type-of-business.model"), exports);
+__exportStar(require("./cost-intersection.model"), exports); // cost intersection
+__exportStar(require("./preference-state.model"), exports); // preferential origin
+__exportStar(require("./invoice-type.model"), exports); // either proforma or tax invoice
+__exportStar(require("./waybill-type.model"), exports); // waybill types
+// Digicust Customers and Users
+__exportStar(require("./customer.model"), exports); // Customer information
+__exportStar(require("./user.model"), exports); // User information
+// Workflow Specific Interfaces
+__exportStar(require("./activity.model"), exports); // tracks activities, used for billing and eventually process mining
+__exportStar(require("./context.model"), exports); // context of a case (not actively used)
+__exportStar(require("./event.model"), exports); // Base model of an event (e.g. webhook or email)
+__exportStar(require("./execution-strategy.model"), exports); // Execution strategies are customer-configurable plans on how to process a specific case.
+__exportStar(require("./module.model"), exports); //  Identifies a module. Modules are different "programs" in the frontend
+__exportStar(require("./errors.model"), exports); // For conceptualizing eg. validation errors
+__exportStar(require("./report.model"), exports); // not actively used
+// HS Codes
+__exportStar(require("./hs-code-mapping"), exports); // mappings from goods descriptions etc. to hs codes
+// Frontend
+__exportStar(require("./frontend-mapping.model"), exports);
+__exportStar(require("./queue.model"), exports);
+__exportStar(require("./masterdata"), exports);
+__exportStar(require("./extractions"), exports);
+// membership
+__exportStar(require("./membership.model"), exports);

package/lib/models/digicust/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/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/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 } 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;
-}
+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,72 +1,72 @@
-import { Adjustment, Container, DigicustDocumentModel, PreferenceState, Procedure } from ".";
-import { AddressModel, Currency, CustomsTariffNumber, Meta, Money, Quantity, UOM, Weight } 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>;
-    packingList?: Meta<string>;
-    position?: Meta<string>;
-    code?: Meta<string>;
-    hsCode?: Meta<string>;
-    amount?: Money;
-    batchNumber?: Meta<string>;
-    lotNumber?: Meta<string>;
-    serialNumber?: Meta<string>;
-    orderNumber?: Meta<string>;
-    description?: Meta<string>;
-    customsTariffNumber?: CustomsTariffNumber;
-    quantity?: Quantity;
-    orderedQuantity?: Quantity;
-    unitOfMeasurement?: Meta<UOM>;
-    countryOfOrigin?: AddressModel;
-    itemValue?: Money;
-    discountText?: string;
-    discount?: Money;
-    currency: Meta<Currency>;
-    totalValue?: Money;
-    customsValue?: Money;
-    /** Net weight per quantity */
-    netWeight?: Weight;
-    /** Net weight for whole quantity */
-    totalNetWeight?: Weight;
-    /** Gross weight per quantity */
-    grossWeight?: Weight;
-    /** Gross weight for whole quantity */
-    totalGrossWeight?: Weight;
-    itemSize?: 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>;
-    procedure?: Procedure;
-    units?: {
-        number?: number;
-        type?: string;
-    }[];
-    preferenceState?: PreferenceState;
-    documents?: DigicustDocumentModel[];
-    adjustments?: Adjustment[];
-    containers?: Container[];
-    /** Reference to material masterdata */
-    materialId?: string;
-    /**
-     * Bounding box of full extracted line (with page)
-     */
-    bbox?: Bbox;
-}
-export declare const condenseLineItem: (lineItem?: LineItemModel | undefined) => LineItemModel | null;
+import { Adjustment, Container, DigicustDocumentModel, PreferenceState, Procedure } from ".";
+import { AddressModel, Currency, CustomsTariffNumber, Meta, Money, Quantity, UOM, Weight } 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>;
+    packingList?: Meta<string>;
+    position?: Meta<string>;
+    code?: Meta<string>;
+    hsCode?: Meta<string>;
+    amount?: Money;
+    batchNumber?: Meta<string>;
+    lotNumber?: Meta<string>;
+    serialNumber?: Meta<string>;
+    orderNumber?: Meta<string>;
+    description?: Meta<string>;
+    customsTariffNumber?: CustomsTariffNumber;
+    quantity?: Quantity;
+    orderedQuantity?: Quantity;
+    unitOfMeasurement?: Meta<UOM>;
+    countryOfOrigin?: AddressModel;
+    itemValue?: Money;
+    discountText?: string;
+    discount?: Money;
+    currency: Meta<Currency>;
+    totalValue?: Money;
+    customsValue?: Money;
+    /** Net weight per quantity */
+    netWeight?: Weight;
+    /** Net weight for whole quantity */
+    totalNetWeight?: Weight;
+    /** Gross weight per quantity */
+    grossWeight?: Weight;
+    /** Gross weight for whole quantity */
+    totalGrossWeight?: Weight;
+    itemSize?: 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>;
+    procedure?: Procedure;
+    units?: {
+        number?: number;
+        type?: string;
+    }[];
+    preferenceState?: PreferenceState;
+    documents?: DigicustDocumentModel[];
+    adjustments?: Adjustment[];
+    containers?: Container[];
+    /** Reference to material masterdata */
+    materialId?: string;
+    /**
+     * Bounding box of full extracted line (with page)
+     */
+    bbox?: Bbox;
+}
+export declare const condenseLineItem: (lineItem?: LineItemModel | undefined) => LineItemModel | null;