digicust_types 1.7.86 → 1.7.90

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

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

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

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

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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,8 @@
+"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

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

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

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

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

@@ -0,0 +1,5 @@
+export declare enum DimensionsUnit {
+    centimeter = "cm",
+    meter = "m",
+    feet = "ft"
+}

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DimensionsUnit = void 0;
+var DimensionsUnit;
+(function (DimensionsUnit) {
+    DimensionsUnit["centimeter"] = "cm";
+    DimensionsUnit["meter"] = "m";
+    DimensionsUnit["feet"] = "ft";
+})(DimensionsUnit = exports.DimensionsUnit || (exports.DimensionsUnit = {}));

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

@@ -0,0 +1,8 @@
+import { DimensionsUnit } from "./dimensions-unit.enum";
+import { Meta } from "./meta";
+export interface Dimensions extends Meta<string> {
+    unit?: DimensionsUnit;
+    height?: number;
+    width?: number;
+    length?: number;
+}

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

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

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

@@ -0,0 +1,21 @@
+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

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

@@ -10,6 +10,8 @@ export * from "./package-type.model";
 export * from "./date.model";
 export * from "./weight.model";
 export * from "./weight-unit.enum";
+export * from "./dimensions.model";
+export * from "./dimensions-unit.enum";
 export * from "./address.model";
 export * from "./company.model";
 export * from "./multerfile.model";

package/lib/models/common/index.js

@@ -23,6 +23,8 @@ __exportStar(require("./package-type.model"), exports); // Information about pac
 __exportStar(require("./date.model"), exports); // Model for date information
 __exportStar(require("./weight.model"), exports); // Information about weight
 __exportStar(require("./weight-unit.enum"), exports); // Weight unit
+__exportStar(require("./dimensions.model"), exports); // Information about dimension
+__exportStar(require("./dimensions-unit.enum"), exports); // Dimension unit
 __exportStar(require("./address.model"), exports); // Model for geographic addresses
 __exportStar(require("./company.model"), exports); // Model for companies
 __exportStar(require("./multerfile.model"), exports); // Files as they arrive on our node servers

package/lib/models/common/super.d.ts

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

package/lib/models/common/super.js

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

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

@@ -0,0 +1,12 @@
+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

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

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

@@ -0,0 +1,18 @@
+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

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

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

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

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

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

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

@@ -0,0 +1,17 @@
+/**
+ * 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

@@ -0,0 +1,21 @@
+"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.model.d.ts

@@ -1,5 +1,5 @@
 import { DigicustDocumentModel, IncotermModel, InvoiceType, LineItemModel, MeanOfTransportation, Package, TaxDetailsModel, TradePreference, TypeOfBusiness } from ".";
-import { AddressModel, CompanyModel, Currency, DateTimeModel, LanguageModel, Meta, Money, PackageType, Weight } from "..";
+import { AddressModel, CompanyModel, Currency, DateTimeModel, Dimensions, LanguageModel, Meta, Money, PackageType, Weight } from "..";
 /**
  * Identifies an invoice
  */
@@ -32,7 +32,7 @@ export interface InvoiceModel extends DigicustDocumentModel {
     typeOfPackage?: PackageType;
     weight?: Weight;
     netWeight?: Weight;
-    packageDimensions?: Meta<string>;
+    packageDimensions?: Dimensions;
     numberOfShipments?: Meta<number>;
     packages?: Package[];
     reGrossWeightWithUom?: Meta<string>;

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

@@ -37,14 +37,12 @@ export interface LineItemModel {
     customsValue?: Money;
     /** Net weight per quantity */
     netWeight?: Weight;
-    netWeightWithUom?: Weight;
     /** Net weight for whole quantity */
     totalNetWeight?: Weight;
     /** Gross weight per quantity */
     grossWeight?: Weight;
     /** Gross weight for whole quantity */
     totalGrossWeight?: Weight;
-    grossWeightWithUom?: Weight;
     itemSize?: Meta<string>;
     buyerArticleNumber?: Meta<string>;
     buyerOrderNumber?: Meta<string>;

package/lib/models/digicust/masterdata/material.model.d.ts

@@ -1,5 +1,5 @@
 import { TradePreference, TypeOfBusinessType } from "..";
-import { CustomsTariffNumber, DateTimeModel, Money, Quantity, UOM, Weight, Workflow } from "../..";
+import { CustomsTariffNumber, DateTimeModel, Dimensions, Money, Quantity, UOM, Weight, Workflow } from "../..";
 export interface ItemPrice {
     price?: Money;
     priceDate?: DateTimeModel;
@@ -49,11 +49,7 @@ export interface MaterialModel {
         starch?: Workflow<number>;
         saccharose?: Workflow<number>;
     };
-    dimensions?: {
-        width?: number;
-        height?: number;
-        length?: number;
-    } & Workflow<any>;
+    dimensions?: Dimensions & Workflow<any>;
     meursingCode?: Workflow<string>[];
     documentTypeCodes?: DocumentTypeCode[];
     customsLaw?: {

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

@@ -0,0 +1,12 @@
+export declare enum StakeholderType {
+    Shipper = "shipper",
+    Recipient = "recipient",
+    Consignee = "consignee",
+    Importer = "importer",
+    Declarant = "declarant",
+    Agent = "agent",
+    Broker = "broker",
+    Buyer = "buyer",
+    Carrier = "carrier",
+    Warehouse = "warehouse"
+}

package/lib/models/digicust/masterdata/stakeholder-type.enum.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StakeholderType = void 0;
+var StakeholderType;
+(function (StakeholderType) {
+    StakeholderType["Shipper"] = "shipper";
+    StakeholderType["Recipient"] = "recipient";
+    StakeholderType["Consignee"] = "consignee";
+    StakeholderType["Importer"] = "importer";
+    StakeholderType["Declarant"] = "declarant";
+    StakeholderType["Agent"] = "agent";
+    StakeholderType["Broker"] = "broker";
+    StakeholderType["Buyer"] = "buyer";
+    StakeholderType["Carrier"] = "carrier";
+    StakeholderType["Warehouse"] = "warehouse";
+})(StakeholderType = exports.StakeholderType || (exports.StakeholderType = {}));

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

@@ -0,0 +1,13 @@
+/**
+ * Information about a notification Model
+ */
+export interface NotificationsModel {
+    id?: string;
+    title?: string;
+    status?: string;
+    message?: string;
+    link?: string;
+    consumer?: string;
+    addresseeType?: "customer" | "project" | "user";
+    addresseeId?: string;
+}

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

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

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

@@ -1,8 +1,8 @@
-import { Meta, Weight } from "../common";
+import { Dimensions, Meta, Weight } from "../common";
 export interface Package extends Meta<any> {
     weight?: Weight;
     netWeight?: Weight;
-    dimensions?: Meta<string>;
+    dimensions?: Dimensions;
     type?: Meta<string>;
     marks?: Meta<string>;
     amount?: Meta<number>;

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

@@ -1,4 +1,4 @@
-import { CompanyModel, Currency, DateTimeModel, LanguageModel, Meta, Money, PackageType, Weight } from "../common";
+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 {
@@ -17,7 +17,7 @@ export interface PackingListModel extends DigicustDocumentModel {
     totalGrossWeight?: Weight;
     totalNetWeight?: Weight;
     typeOfPackage?: PackageType;
-    packageDimensions?: Meta<string>;
+    packageDimensions?: Dimensions;
     amountOfPackages?: Meta<Number>;
     totalExcludingCharges?: Money;
     insuranceCosts?: Money;

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

@@ -0,0 +1,25 @@
+import { Meta } from "../common";
+export interface ShippingType extends Meta<ShippingMode> {
+    /** unique identifier of the transportation mean */
+    code?: string;
+    name?: string;
+    type?: ShippingTypePlace;
+    /** ISO Code of nationality of the mean */
+    countryCode?: string;
+}
+export declare enum ShippingMode {
+    maritime = "Maritime",
+    rail = "Rail",
+    road = "Road",
+    air = "Air",
+    postal = "Postal",
+    fixedInstallations = "FixedInstallations",
+    inlandWaterway = "InlandWaterway",
+    unknown = "Unknown"
+}
+export declare enum ShippingTypePlace {
+    border = "Border",
+    arrival = "Arrival",
+    departure = "Departure",
+    inland = "Inland"
+}

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

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShippingTypePlace = exports.ShippingMode = void 0;
+var ShippingMode;
+(function (ShippingMode) {
+    ShippingMode["maritime"] = "Maritime";
+    ShippingMode["rail"] = "Rail";
+    ShippingMode["road"] = "Road";
+    ShippingMode["air"] = "Air";
+    ShippingMode["postal"] = "Postal";
+    ShippingMode["fixedInstallations"] = "FixedInstallations";
+    ShippingMode["inlandWaterway"] = "InlandWaterway";
+    ShippingMode["unknown"] = "Unknown";
+})(ShippingMode = exports.ShippingMode || (exports.ShippingMode = {}));
+var ShippingTypePlace;
+(function (ShippingTypePlace) {
+    ShippingTypePlace["border"] = "Border";
+    ShippingTypePlace["arrival"] = "Arrival";
+    ShippingTypePlace["departure"] = "Departure";
+    ShippingTypePlace["inland"] = "Inland";
+})(ShippingTypePlace = exports.ShippingTypePlace || (exports.ShippingTypePlace = {}));

package/lib/models/digicust/submission-case-model.d.ts

@@ -0,0 +1,8 @@
+import { Meta } from "../common";
+/**
+ * Information about the submission at a customs authority
+ */
+export interface CaseSubmissionModel {
+    mrnNumber?: Meta<string>;
+    accomplishedAt?: Date;
+}

package/lib/models/digicust/submission-case-model.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "digicust_types",
-  "version": "1.7.86",
+  "version": "1.7.90",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -9,7 +9,8 @@
   ],
   "scripts": {
     "build": "tsc",
-    "build-deploy": "npm version patch && tsc && npm publish"
+    "build-deploy": "npm version patch && tsc && npm publish",
+    "deploy-docs": "npm i && npx typedoc src/index.ts"
   },
   "repository": {
     "type": "git",
@@ -23,7 +24,8 @@
   },
   "homepage": "https://github.com/Digicust0406/types#readme",
   "dependencies": {
-    "@types/node": "^14.17.32"
+    "@types/node": "^14.17.33",
+    "typedoc": "^0.22.7"
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^4.33.0",