@shipengine/connect-carrier-api 4.1.1 → 4.1.3

package/lib/models/dangerous-good/dangerous-goods.d.ts

@@ -0,0 +1,46 @@
+import { PackageInstructionSectionTypes } from './package-instruction-section-types';
+import { PackagingGroupTypes } from './packaging-group-types';
+import { RegulationLevelTypes } from './regulation-level-types';
+import { TransportMeanTypes } from './transport-mean-types';
+import { DangerousAmountDetails } from './weight-details';
+/** @description Basic structure for a dangerous goods */
+export declare class DangerousGoods {
+    /** @description UN number to identify the dangerous goods */
+    id_number?: string;
+    /** @description Trade description of the dangerous goods */
+    shipping_name?: string;
+    /** @description Recognized Technical or chemical name of dangerous goods */
+    technical_name?: string;
+    /** @description Dangerous goods product class based on regulation */
+    product_class?: string;
+    /** @description A secondary of product class for substances presenting more than one particular hazard */
+    product_class_subsidiary?: string;
+    /** @description This indicates the packaging group based on the degree of danger */
+    packaging_group?: PackagingGroupTypes;
+    /** @description The amount of the dangerous goods */
+    dangerous_amount?: DangerousAmountDetails;
+    /** @description Quantity of dangerous goods */
+    quantity?: number;
+    /** @description The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container */
+    packaging_instruction?: string;
+    /** @description Complementary information to specify the exact 'Section of Packaging' instructions */
+    packaging_instruction_section?: PackageInstructionSectionTypes;
+    /** @description The type of exterior packaging used to contain the dangerous good */
+    packaging_type?: string;
+    /** @description Transportation means through which the dangerous goods are transported */
+    transport_mean?: TransportMeanTypes;
+    /** @description Transport category assign to dangerous goods for the transport purpose */
+    transport_category?: string;
+    /** @description Name of the regulatory authority */
+    regulation_authority?: string;
+    /** @description Regulation level of the dangerous goods */
+    regulation_level?: RegulationLevelTypes;
+    /** @description Indication if the substance is radioactive */
+    radioactive?: boolean;
+    /** @description Indication if the substance needs to be reported to regulatory authority based on the quantity */
+    reportable_quantity?: boolean;
+    /** @description Defines which types of tunnels the shipment is allowed to go through */
+    tunnel_code?: string;
+    /** @description Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier */
+    additional_description?: string;
+}

package/lib/models/dangerous-good/dangerous-goods.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DangerousGoods = void 0;
+/** @description Basic structure for a dangerous goods */
+class DangerousGoods {
+    /** @description UN number to identify the dangerous goods */
+    id_number;
+    /** @description Trade description of the dangerous goods */
+    shipping_name;
+    /** @description Recognized Technical or chemical name of dangerous goods */
+    technical_name;
+    /** @description Dangerous goods product class based on regulation */
+    product_class;
+    /** @description A secondary of product class for substances presenting more than one particular hazard */
+    product_class_subsidiary;
+    /** @description This indicates the packaging group based on the degree of danger */
+    packaging_group;
+    /** @description The amount of the dangerous goods */
+    dangerous_amount;
+    /** @description Quantity of dangerous goods */
+    quantity;
+    /** @description The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container */
+    packaging_instruction;
+    /** @description Complementary information to specify the exact 'Section of Packaging' instructions */
+    packaging_instruction_section;
+    /** @description The type of exterior packaging used to contain the dangerous good */
+    packaging_type;
+    /** @description Transportation means through which the dangerous goods are transported */
+    transport_mean;
+    /** @description Transport category assign to dangerous goods for the transport purpose */
+    transport_category;
+    /** @description Name of the regulatory authority */
+    regulation_authority;
+    /** @description Regulation level of the dangerous goods */
+    regulation_level;
+    /** @description Indication if the substance is radioactive */
+    radioactive;
+    /** @description Indication if the substance needs to be reported to regulatory authority based on the quantity */
+    reportable_quantity;
+    /** @description Defines which types of tunnels the shipment is allowed to go through */
+    tunnel_code;
+    /** @description Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier */
+    additional_description;
+}
+exports.DangerousGoods = DangerousGoods;
+//# sourceMappingURL=dangerous-goods.js.map

package/lib/models/dangerous-good/dangerous-goods.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dangerous-goods.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods.ts"],"names":[],"mappings":";;;AAMA,yDAAyD;AACzD,MAAa,cAAc;IACzB,6DAA6D;IAC7D,SAAS,CAAU;IACnB,4DAA4D;IAC5D,aAAa,CAAU;IACvB,4EAA4E;IAC5E,cAAc,CAAU;IACxB,qEAAqE;IACrE,aAAa,CAAU;IACvB,0GAA0G;IAC1G,wBAAwB,CAAU;IAClC,oFAAoF;IACpF,eAAe,CAAuB;IACtC,qDAAqD;IACrD,gBAAgB,CAA0B;IAC1C,+CAA+C;IAC/C,QAAQ,CAAU;IAClB,uJAAuJ;IACvJ,qBAAqB,CAAU;IAC/B,sGAAsG;IACtG,6BAA6B,CAAkC;IAC/D,qFAAqF;IACrF,cAAc,CAAU;IACxB,0FAA0F;IAC1F,cAAc,CAAsB;IACpC,0FAA0F;IAC1F,kBAAkB,CAAU;IAC5B,oDAAoD;IACpD,oBAAoB,CAAU;IAC9B,2DAA2D;IAC3D,gBAAgB,CAAwB;IACxC,8DAA8D;IAC9D,WAAW,CAAW;IACtB,kHAAkH;IAClH,mBAAmB,CAAW;IAC9B,wFAAwF;IACxF,WAAW,CAAU;IACrB,sKAAsK;IACtK,sBAAsB,CAAU;CACjC;AAvCD,wCAuCC"}

package/lib/models/dangerous-good/package-instruction-section-types.d.ts

@@ -0,0 +1,7 @@
+/** @description Complementary information to specify the exact 'Section of Packaging' Instructions (a mandatory piece of data for processing lithium batteries shipments). */
+export declare enum PackageInstructionSectionTypes {
+    Section1 = "section_1",
+    Section2 = "section_2",
+    Section1A = "section_1A",
+    Section1B = "section_1B"
+}

package/lib/models/dangerous-good/package-instruction-section-types.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackageInstructionSectionTypes = void 0;
+/** @description Complementary information to specify the exact 'Section of Packaging' Instructions (a mandatory piece of data for processing lithium batteries shipments). */
+var PackageInstructionSectionTypes;
+(function (PackageInstructionSectionTypes) {
+    PackageInstructionSectionTypes["Section1"] = "section_1";
+    PackageInstructionSectionTypes["Section2"] = "section_2";
+    PackageInstructionSectionTypes["Section1A"] = "section_1A";
+    PackageInstructionSectionTypes["Section1B"] = "section_1B";
+})(PackageInstructionSectionTypes = exports.PackageInstructionSectionTypes || (exports.PackageInstructionSectionTypes = {}));
+//# sourceMappingURL=package-instruction-section-types.js.map

package/lib/models/dangerous-good/package-instruction-section-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-instruction-section-types.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/package-instruction-section-types.ts"],"names":[],"mappings":";;;AAAA,8KAA8K;AAC9K,IAAY,8BAKX;AALD,WAAY,8BAA8B;IACxC,wDAAsB,CAAA;IACtB,wDAAsB,CAAA;IACtB,0DAAwB,CAAA;IACxB,0DAAwB,CAAA;AAC1B,CAAC,EALW,8BAA8B,GAA9B,sCAA8B,KAA9B,sCAA8B,QAKzC"}

package/lib/models/dangerous-good/packaging-group-types.d.ts

@@ -0,0 +1,9 @@
+/** @description Types of packaging group for dangerous good and it indicates the degree of danger */
+export declare enum PackagingGroupTypes {
+    /** @description level 1 */
+    i = "i",
+    /** @description level 2 */
+    ii = "ii",
+    /** @description level 3 */
+    iii = "iii"
+}

package/lib/models/dangerous-good/packaging-group-types.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackagingGroupTypes = void 0;
+/** @description Types of packaging group for dangerous good and it indicates the degree of danger */
+var PackagingGroupTypes;
+(function (PackagingGroupTypes) {
+    /** @description level 1 */
+    PackagingGroupTypes["i"] = "i";
+    /** @description level 2 */
+    PackagingGroupTypes["ii"] = "ii";
+    /** @description level 3 */
+    PackagingGroupTypes["iii"] = "iii";
+})(PackagingGroupTypes = exports.PackagingGroupTypes || (exports.PackagingGroupTypes = {}));
+//# sourceMappingURL=packaging-group-types.js.map

package/lib/models/dangerous-good/packaging-group-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"packaging-group-types.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/packaging-group-types.ts"],"names":[],"mappings":";;;AAAA,qGAAqG;AACrG,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,2BAA2B;IAC3B,8BAAO,CAAA;IACP,2BAA2B;IAC3B,gCAAS,CAAA;IACT,2BAA2B;IAC3B,kCAAW,CAAA;AACb,CAAC,EAPW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAO9B"}

package/lib/models/dangerous-good/regulation-level-types.d.ts

@@ -0,0 +1,11 @@
+/** @description Types of regulation level defined for dangerous good */
+export declare enum RegulationLevelTypes {
+    /** @description lightly regulated */
+    LightlyRegulated = "lightly_regulated",
+    /** @description fully regualted */
+    FullyRegulated = "fully_regulated",
+    /** @description limited quantities regulated */
+    LimitedQuantities = "limited_quantities",
+    /** @description excepted quantity regulated */
+    ExceptedQuantity = "excepted_quantity"
+}

package/lib/models/dangerous-good/regulation-level-types.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegulationLevelTypes = void 0;
+/** @description Types of regulation level defined for dangerous good */
+var RegulationLevelTypes;
+(function (RegulationLevelTypes) {
+    /** @description lightly regulated */
+    RegulationLevelTypes["LightlyRegulated"] = "lightly_regulated";
+    /** @description fully regualted */
+    RegulationLevelTypes["FullyRegulated"] = "fully_regulated";
+    /** @description limited quantities regulated */
+    RegulationLevelTypes["LimitedQuantities"] = "limited_quantities";
+    /** @description excepted quantity regulated */
+    RegulationLevelTypes["ExceptedQuantity"] = "excepted_quantity";
+})(RegulationLevelTypes = exports.RegulationLevelTypes || (exports.RegulationLevelTypes = {}));
+//# sourceMappingURL=regulation-level-types.js.map

package/lib/models/dangerous-good/regulation-level-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"regulation-level-types.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/regulation-level-types.ts"],"names":[],"mappings":";;;AAAA,wEAAwE;AACxE,IAAY,oBASX;AATD,WAAY,oBAAoB;IAC9B,qCAAqC;IACrC,8DAAsC,CAAA;IACtC,mCAAmC;IACnC,0DAAkC,CAAA;IAClC,gDAAgD;IAChD,gEAAwC,CAAA;IACxC,+CAA+C;IAC/C,8DAAsC,CAAA;AACxC,CAAC,EATW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAS/B"}

package/lib/models/dangerous-good/transport-mean-types.d.ts

@@ -0,0 +1,11 @@
+/** @description Types of transport mean for dangerous good */
+export declare enum TransportMeanTypes {
+    /** @description ground transport */
+    Ground = "ground",
+    /** @description water transport */
+    Water = "water",
+    /** @description cargo aircraft only transport */
+    Cargo_Aircraft_Only = "cargo_aircraft_only",
+    /** @description passenger aircraft transport */
+    Passenger_Aircraft = "passenger_aircraft"
+}

package/lib/models/dangerous-good/transport-mean-types.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransportMeanTypes = void 0;
+/** @description Types of transport mean for dangerous good */
+var TransportMeanTypes;
+(function (TransportMeanTypes) {
+    /** @description ground transport */
+    TransportMeanTypes["Ground"] = "ground";
+    /** @description water transport */
+    TransportMeanTypes["Water"] = "water";
+    /** @description cargo aircraft only transport */
+    TransportMeanTypes["Cargo_Aircraft_Only"] = "cargo_aircraft_only";
+    /** @description passenger aircraft transport */
+    TransportMeanTypes["Passenger_Aircraft"] = "passenger_aircraft";
+})(TransportMeanTypes = exports.TransportMeanTypes || (exports.TransportMeanTypes = {}));
+//# sourceMappingURL=transport-mean-types.js.map

package/lib/models/dangerous-good/transport-mean-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transport-mean-types.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/transport-mean-types.ts"],"names":[],"mappings":";;;AAAA,8DAA8D;AAC9D,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,oCAAoC;IACpC,uCAAiB,CAAA;IACjB,mCAAmC;IACnC,qCAAe,CAAA;IACf,iDAAiD;IACjD,iEAA2C,CAAA;IAC3C,gDAAgD;IAChD,+DAAyC,CAAA;AAC3C,CAAC,EATW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAS7B"}

package/lib/models/dangerous-good/weight-details.d.ts

@@ -0,0 +1,7 @@
+/** @description This model represents the amount of the dangerous goods */
+export declare class DangerousAmountDetails {
+    /** @description The amount of dangerous goods */
+    amount?: number;
+    /** @description The unit of dangerous goods */
+    unit?: string;
+}

package/lib/models/dangerous-good/weight-details.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DangerousAmountDetails = void 0;
+/** @description This model represents the amount of the dangerous goods */
+class DangerousAmountDetails {
+    /** @description The amount of dangerous goods */
+    amount;
+    /** @description The unit of dangerous goods */
+    unit;
+}
+exports.DangerousAmountDetails = DangerousAmountDetails;
+//# sourceMappingURL=weight-details.js.map

package/lib/models/dangerous-good/weight-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"weight-details.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/weight-details.ts"],"names":[],"mappings":";;;AAAA,2EAA2E;AAC3E,MAAa,sBAAsB;IACjC,iDAAiD;IACjD,MAAM,CAAU;IAChB,+CAA+C;IAC/C,IAAI,CAAU;CACf;AALD,wDAKC"}

package/lib/models/package.d.ts

@@ -3,6 +3,7 @@ import { WeightDetails } from './units/weight-details';
 import { Currency } from './currency';
 import { LabelMessage } from './labels/label-message';
 import { Customs } from './customs';
+import { DangerousGoods } from './dangerous-good/dangerous-goods';
 /** @description Basic structure for a package */
 export declare class Package {
     /** @description Package code defined for the carrier in ShipEngine. */
@@ -19,4 +20,6 @@ export declare class Package {
     label_messages?: LabelMessage;
     /** @description Basic structure for a customs declaration (Only available on international shipments) */
     customs?: Customs;
+    /** @description List of dangerous goods model associated with this package passed to the carrier. */
+    dangerous_goods?: DangerousGoods[];
 }

package/lib/models/package.js

@@ -17,6 +17,8 @@ class Package {
     label_messages;
     /** @description Basic structure for a customs declaration (Only available on international shipments) */
     customs;
+    /** @description List of dangerous goods model associated with this package passed to the carrier. */
+    dangerous_goods;
 }
 exports.Package = Package;
 //# sourceMappingURL=package.js.map

package/lib/models/package.js.map

@@ -1 +1 @@
-{"version":3,"file":"package.js","sourceRoot":"","sources":["../../src/models/package.ts"],"names":[],"mappings":";;;AAMA,iDAAiD;AACjD,MAAa,OAAO;IAClB,uEAAuE;IACvE,YAAY,CAAU;IACtB,sIAAsI;IACtI,mBAAmB,CAAU;IAC7B,+DAA+D;IAC/D,iBAAiB,CAAoB;IACrC,2DAA2D;IAC3D,cAAc,CAAiB;IAC/B,sDAAsD;IACtD,aAAa,CAAY;IACzB,2EAA2E;IAC3E,cAAc,CAAgB;IAC9B,yGAAyG;IACzG,OAAO,CAAW;CACnB;AAfD,0BAeC"}
+{"version":3,"file":"package.js","sourceRoot":"","sources":["../../src/models/package.ts"],"names":[],"mappings":";;;AAOA,iDAAiD;AACjD,MAAa,OAAO;IAClB,uEAAuE;IACvE,YAAY,CAAU;IACtB,sIAAsI;IACtI,mBAAmB,CAAU;IAC7B,+DAA+D;IAC/D,iBAAiB,CAAoB;IACrC,2DAA2D;IAC3D,cAAc,CAAiB;IAC/B,sDAAsD;IACtD,aAAa,CAAY;IACzB,2EAA2E;IAC3E,cAAc,CAAgB;IAC9B,yGAAyG;IACzG,OAAO,CAAW;IAClB,qGAAqG;IACrG,eAAe,CAAoB;CACpC;AAjBD,0BAiBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.1.1",
+  "version": "4.1.3",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",

package/spec.json

@@ -1177,6 +1177,45 @@
         ],
         "type": "string"
       },
+      "PackagingGroupTypes": {
+        "enum": [
+          "i",
+          "ii",
+          "iii"
+        ],
+        "type": "string",
+        "description": "An enumeration for packaging group for dangerous goods."
+      },
+      "PackageInstructionSectionTypes": {
+        "enum": [
+          "section_1",
+          "section_2",
+          "section_1A",
+          "section_1B"
+        ],
+        "type": "string",
+        "description": "An enumeration for package instruction for dangerous goods."
+      },
+      "TransportMeanTypes": {
+        "enum": [
+          "ground",
+          "water",
+          "cargo_aircraft_only",
+          "passenger_aircraft"
+        ],
+        "type": "string",
+        "description": "An enumeration for transport means for dangerous goods."
+      },
+      "RegulationLevelTypes": {
+        "enum": [
+          "lightly_regulated",
+          "fully_regulated",
+          "limited_quantities",
+          "excepted_quantity"
+        ],
+        "type": "string",
+        "description": "An enumeration for regulation type for dangerous goods."
+      },
       "CreateLabelRequest": {
         "required": [
           "service_code",
@@ -1836,6 +1875,24 @@
         "type": "string",
         "description": "What to do if the shipment is undeliverable."
       },
+      "DangerousAmountDetails": {
+        "type": "object",
+        "properties": {
+          "amount": {
+            "type": "number",
+            "description": "The amount of dangerous goods.",
+            "format": "double",
+            "nullable": true
+          },
+          "unit": {
+            "type": "string",
+            "description": "The unit of dangerous goods.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "This model represents the amount of the dangerous goods."
+      },
       "DimensionDetails": {
         "type": "object",
         "properties": {
@@ -2761,11 +2818,112 @@
           },
           "customs": {
             "$ref": "#/components/schemas/Customs"
+          },
+          "dangerous_goods": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/DangerousGoods"
+            },
+            "description": "List of dangerous Goods model associated with this package passed to the carrier.",
+            "nullable": true
           }
         },
         "additionalProperties": false,
         "description": "This model represents an individual package that is part of a shipment."
       },
+      "DangerousGoods": {
+        "type": "object",
+        "properties": {
+          "id_number": {
+            "type": "string",
+            "description": "UN number to identify the dangerous goods.",
+            "nullable": true
+          },
+          "shipping_name": {
+            "type": "string",
+            "description": "Trade description of the dangerous goods.",
+            "nullable": true
+          },
+          "technical_name": {
+            "type": "string",
+            "description": "Recognized Technical or chemical name of dangerous goods.",
+            "nullable": true
+          },
+          "product_class": {
+            "type": "string",
+            "description": "Dangerous goods product class based on regulation.",
+            "nullable": true
+          },
+          "product_class_subsidiary": {
+            "type": "string",
+            "description": "A secondary of product class for substances presenting more than one particular hazard.",
+            "nullable": true
+          },
+          "packaging_group": {
+            "$ref": "#/components/schemas/PackagingGroupTypes"
+          },
+          "dangerous_amount": {
+            "$ref": "#/components/schemas/DangerousAmountDetails"
+          },
+          "quantity": {
+            "type": "number",
+            "description": "Quantity of dangerous goods.",
+            "format": "double",
+            "nullable": true
+          },
+          "packaging_instruction": {
+            "type": "string",
+            "description": "The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.",
+            "nullable": true
+          },
+          "packaging_instruction_section": {
+            "$ref": "#/components/schemas/PackageInstructionSectionTypes"
+          },
+          "packaging_type": {
+            "type": "string",
+            "description": "The type of exterior packaging used to contain the dangerous good.",
+            "nullable": true
+          },
+          "transport_mean": {
+            "$ref": "#/components/schemas/TransportMeanTypes"
+          },
+          "transport_category": {
+            "type": "string",
+            "description": "Transport category assign to dangerous goods for the transport purpose.",
+            "nullable": true
+          },
+          "regulation_authority": {
+            "type": "string",
+            "description": "Name of the regulatory authority.",
+            "nullable": true
+          },
+          "regulation_level": {
+            "$ref": "#/components/schemas/RegulationLevelTypes"
+          },
+          "radioactive": {
+            "type": "boolean",
+            "description": "Indication if the substance is radioactive.",
+            "nullable": true
+          },
+          "reportable_quantity": {
+            "type": "boolean",
+            "description": "Indication if the substance needs to be reported to regulatory authority based on the quantity.",
+            "nullable": true
+          },
+          "tunnel_code": {
+            "type": "string",
+            "description": "Defines which types of tunnels the shipment is allowed to go through.",
+            "nullable": true
+          },
+          "additional_description": {
+            "type": "string",
+            "description": "Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "This model represents an dangerous good information that is part of a package."
+      },
       "PickupConfirmation": {
         "type": "object",
         "properties": {

package/src/models/dangerous-good/dangerous-goods.ts

@@ -0,0 +1,47 @@
+import { PackageInstructionSectionTypes } from './package-instruction-section-types';
+import { PackagingGroupTypes } from './packaging-group-types';
+import { RegulationLevelTypes } from './regulation-level-types';
+import { TransportMeanTypes } from './transport-mean-types';
+import { DangerousAmountDetails } from './weight-details';
+
+/** @description Basic structure for a dangerous goods */
+export class DangerousGoods {
+  /** @description UN number to identify the dangerous goods */
+  id_number?: string;
+  /** @description Trade description of the dangerous goods */
+  shipping_name?: string;
+  /** @description Recognized Technical or chemical name of dangerous goods */
+  technical_name?: string;
+  /** @description Dangerous goods product class based on regulation */
+  product_class?: string;
+  /** @description A secondary of product class for substances presenting more than one particular hazard */
+  product_class_subsidiary?: string;
+  /** @description This indicates the packaging group based on the degree of danger */
+  packaging_group?: PackagingGroupTypes;
+  /** @description The amount of the dangerous goods */
+  dangerous_amount?: DangerousAmountDetails;
+  /** @description Quantity of dangerous goods */
+  quantity?: number;
+  /** @description The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container */
+  packaging_instruction?: string;
+  /** @description Complementary information to specify the exact 'Section of Packaging' instructions */
+  packaging_instruction_section?: PackageInstructionSectionTypes;
+  /** @description The type of exterior packaging used to contain the dangerous good */
+  packaging_type?: string;
+  /** @description Transportation means through which the dangerous goods are transported */
+  transport_mean?: TransportMeanTypes;
+  /** @description Transport category assign to dangerous goods for the transport purpose */
+  transport_category?: string;
+  /** @description Name of the regulatory authority */
+  regulation_authority?: string;
+  /** @description Regulation level of the dangerous goods */
+  regulation_level?: RegulationLevelTypes;
+  /** @description Indication if the substance is radioactive */
+  radioactive?: boolean;
+  /** @description Indication if the substance needs to be reported to regulatory authority based on the quantity */
+  reportable_quantity?: boolean;
+  /** @description Defines which types of tunnels the shipment is allowed to go through */
+  tunnel_code?: string;
+  /** @description Provider additonal description regarding the dangerous goods. This is used as a placed holder to provider additional context and varies by carrier */
+  additional_description?: string;
+}

package/src/models/dangerous-good/package-instruction-section-types.ts

@@ -0,0 +1,7 @@
+/** @description Complementary information to specify the exact 'Section of Packaging' Instructions (a mandatory piece of data for processing lithium batteries shipments). */
+export enum PackageInstructionSectionTypes {
+  Section1 = 'section_1',
+  Section2 = 'section_2',
+  Section1A = 'section_1A',
+  Section1B = 'section_1B',
+}

package/src/models/dangerous-good/packaging-group-types.ts

@@ -0,0 +1,9 @@
+/** @description Types of packaging group for dangerous good and it indicates the degree of danger */
+export enum PackagingGroupTypes {
+  /** @description level 1 */
+  i = 'i',
+  /** @description level 2 */
+  ii = 'ii',
+  /** @description level 3 */
+  iii = 'iii',
+}

package/src/models/dangerous-good/regulation-level-types.ts

@@ -0,0 +1,11 @@
+/** @description Types of regulation level defined for dangerous good */
+export enum RegulationLevelTypes {
+  /** @description lightly regulated */
+  LightlyRegulated = 'lightly_regulated',
+  /** @description fully regualted */
+  FullyRegulated = 'fully_regulated',
+  /** @description limited quantities regulated */
+  LimitedQuantities = 'limited_quantities',
+  /** @description excepted quantity regulated */
+  ExceptedQuantity = 'excepted_quantity',
+}

package/src/models/dangerous-good/transport-mean-types.ts

@@ -0,0 +1,11 @@
+/** @description Types of transport mean for dangerous good */
+export enum TransportMeanTypes {
+  /** @description ground transport */
+  Ground = 'ground',
+  /** @description water transport */
+  Water = 'water',
+  /** @description cargo aircraft only transport */
+  Cargo_Aircraft_Only = 'cargo_aircraft_only',
+  /** @description passenger aircraft transport */
+  Passenger_Aircraft = 'passenger_aircraft',
+}

package/src/models/dangerous-good/weight-details.ts

@@ -0,0 +1,7 @@
+/** @description This model represents the amount of the dangerous goods */
+export class DangerousAmountDetails {
+  /** @description The amount of dangerous goods */
+  amount?: number;
+  /** @description The unit of dangerous goods */
+  unit?: string;
+}

package/src/models/package.ts

@@ -3,6 +3,7 @@ import { WeightDetails } from './units/weight-details';
 import { Currency } from './currency';
 import { LabelMessage } from './labels/label-message';
 import { Customs } from './customs';
+import { DangerousGoods } from './dangerous-good/dangerous-goods';
 
 /** @description Basic structure for a package */
 export class Package {
@@ -20,4 +21,6 @@ export class Package {
   label_messages?: LabelMessage;
   /** @description Basic structure for a customs declaration (Only available on international shipments) */
   customs?: Customs;
+  /** @description List of dangerous goods model associated with this package passed to the carrier. */
+  dangerous_goods?: DangerousGoods[];
 }