@shipengine/connect-carrier-api 4.1.5 → 4.1.7

package/lib/models/insurance-providers.d.ts

@@ -3,5 +3,7 @@ export declare enum InsuranceProviders {
     None = "None",
     ShipStation = "ShipStation",
     Carrier = "Carrier",
-    External = "External"
+    External = "External",
+    XCover = "XCover",
+    ParcelGuard = "ParcelGuard"
 }

package/lib/models/insurance-providers.js

@@ -8,5 +8,7 @@ var InsuranceProviders;
     InsuranceProviders["ShipStation"] = "ShipStation";
     InsuranceProviders["Carrier"] = "Carrier";
     InsuranceProviders["External"] = "External";
+    InsuranceProviders["XCover"] = "XCover";
+    InsuranceProviders["ParcelGuard"] = "ParcelGuard";
 })(InsuranceProviders = exports.InsuranceProviders || (exports.InsuranceProviders = {}));
 //# sourceMappingURL=insurance-providers.js.map

package/lib/models/insurance-providers.js.map

@@ -1 +1 @@
-{"version":3,"file":"insurance-providers.js","sourceRoot":"","sources":["../../src/models/insurance-providers.ts"],"names":[],"mappings":";;;AAAA,0CAA0C;AAC1C,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,iDAA2B,CAAA;IAC3B,yCAAmB,CAAA;IACnB,2CAAqB,CAAA;AACvB,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B"}
+{"version":3,"file":"insurance-providers.js","sourceRoot":"","sources":["../../src/models/insurance-providers.ts"],"names":[],"mappings":";;;AAAA,0CAA0C;AAC1C,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,iDAA2B,CAAA;IAC3B,yCAAmB,CAAA;IACnB,2CAAqB,CAAA;IACrB,uCAAiB,CAAA;IACjB,iDAA2B,CAAA;AAC7B,CAAC,EAPW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAO7B"}

package/lib/models/package.d.ts

@@ -3,7 +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';
+import { Products } from './products';
 /** @description Basic structure for a package */
 export declare class Package {
     /** @description Package code defined for the carrier in ShipEngine. */
@@ -20,6 +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[];
+    /** @description List of products goods model associated with this package passed to the carrier. */
+    products?: Products[];
 }

package/lib/models/package.js

@@ -17,8 +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;
+    /** @description List of products goods model associated with this package passed to the carrier. */
+    products;
 }
 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":";;;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"}
+{"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,oGAAoG;IACpG,QAAQ,CAAc;CACvB;AAjBD,0BAiBC"}

package/lib/models/products.d.ts

@@ -0,0 +1,30 @@
+import { WeightDetails } from './units/weight-details';
+import { Currency } from './currency';
+import { DangerousGoods } from './dangerous-good/dangerous-goods';
+/** @description Basic structure for a product */
+export declare class Products {
+    /** @description A user specified free form string describing this customs item. If the field is absent the user has not specified a description */
+    description?: string;
+    /** @description The user specified count of items in this declaration. This value should be 1 or greater */
+    quantity?: number;
+    /** @description The user specified declared customs value of this customs item. Generally, this value needs to be greater than 0 to be accepted through customs */
+    value?: Currency;
+    /** @description The user specified declared country of origin of this customs item */
+    country_of_origin?: string;
+    /** @description The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information */
+    harmonized_tariff_code?: string;
+    /** @description The user specified SKU of this customs item. This field is completely free form. */
+    sku?: string;
+    /** @description The user specified SKU description of this customs item. This field is completely free form. */
+    sku_description?: string;
+    /** @description Detailed information about the weight of this item */
+    item_weight?: WeightDetails;
+    /** @description A link to the item being shipped on the seller's website, used by customs officials to visually compare the item in the package to the available photo on the website. */
+    product_url?: string;
+    /** @description The VAT rate applicable to the item being shipped, expressed as a decimal value between 0 and 1. */
+    vat_rate?: number;
+    /** @description The Manufacturer Identification Code (MID). It is ussed as an alternative to the full name and address of a manufacturer, shipper or exporter and is always required for U.S. formal customs entries. */
+    mid_code?: string;
+    /** @description List of dangerous goods model associated with this package passed to the carrier. */
+    dangerous_goods?: DangerousGoods[];
+}

package/lib/models/products.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Products = void 0;
+/** @description Basic structure for a product */
+class Products {
+    /** @description A user specified free form string describing this customs item. If the field is absent the user has not specified a description */
+    description;
+    /** @description The user specified count of items in this declaration. This value should be 1 or greater */
+    quantity;
+    /** @description The user specified declared customs value of this customs item. Generally, this value needs to be greater than 0 to be accepted through customs */
+    value;
+    /** @description The user specified declared country of origin of this customs item */
+    country_of_origin;
+    /** @description The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information */
+    harmonized_tariff_code;
+    /** @description The user specified SKU of this customs item. This field is completely free form. */
+    sku;
+    /** @description The user specified SKU description of this customs item. This field is completely free form. */
+    sku_description;
+    /** @description Detailed information about the weight of this item */
+    item_weight;
+    /** @description A link to the item being shipped on the seller's website, used by customs officials to visually compare the item in the package to the available photo on the website. */
+    product_url;
+    /** @description The VAT rate applicable to the item being shipped, expressed as a decimal value between 0 and 1. */
+    vat_rate;
+    /** @description The Manufacturer Identification Code (MID). It is ussed as an alternative to the full name and address of a manufacturer, shipper or exporter and is always required for U.S. formal customs entries. */
+    mid_code;
+    /** @description List of dangerous goods model associated with this package passed to the carrier. */
+    dangerous_goods;
+}
+exports.Products = Products;
+//# sourceMappingURL=products.js.map

package/lib/models/products.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/models/products.ts"],"names":[],"mappings":";;;AAIA,iDAAiD;AACjD,MAAa,QAAQ;IACnB,mJAAmJ;IACnJ,WAAW,CAAU;IACrB,4GAA4G;IAC5G,QAAQ,CAAU;IAClB,mKAAmK;IACnK,KAAK,CAAY;IACjB,sFAAsF;IACtF,iBAAiB,CAAU;IAC3B,8GAA8G;IAC9G,sBAAsB,CAAU;IAChC,oGAAoG;IACpG,GAAG,CAAU;IACb,gHAAgH;IAChH,eAAe,CAAU;IACzB,sEAAsE;IACtE,WAAW,CAAiB;IAC5B,0LAA0L;IAC1L,WAAW,CAAU;IACrB,oHAAoH;IACpH,QAAQ,CAAU;IAClB,yNAAyN;IACzN,QAAQ,CAAU;IAClB,qGAAqG;IACrG,eAAe,CAAoB;CACpC;AAzBD,4BAyBC"}

package/package.json

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

package/spec.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Shipping API",
     "description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
-    "version": "1.18.1"
+    "version": "1.18.5"
   },
   "paths": {
     "/Register": {
@@ -1893,6 +1893,99 @@
         "additionalProperties": false,
         "description": "This model represents the amount of the dangerous goods."
       },
+      "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/PackagingGroupEnum"
+          },
+          "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/PackageInstructionSectionEnum"
+          },
+          "packaging_type": {
+            "type": "string",
+            "description": "The type of exterior packaging used to contain the dangerous good.",
+            "nullable": true
+          },
+          "transport_mean": {
+            "$ref": "#/components/schemas/TransportMeanEnum"
+          },
+          "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/RegulationLevelEnum"
+          },
+          "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": "Dangerous Goods information passed to the carrier"
+      },
       "DimensionDetails": {
         "type": "object",
         "properties": {
@@ -2519,7 +2612,9 @@
           "None",
           "ShipStation",
           "Carrier",
-          "External"
+          "External",
+          "XCover",
+          "ParcelGuard"
         ],
         "type": "string"
       },
@@ -2819,110 +2914,34 @@
           "customs": {
             "$ref": "#/components/schemas/Customs"
           },
-          "dangerous_goods": {
+          "products": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/DangerousGoods"
+              "$ref": "#/components/schemas/Products"
             },
-            "description": "List of dangerous Goods model associated with this package passed to the carrier.",
+            "description": "List of products associated with this package.",
             "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."
+      "PackageInstructionSectionEnum": {
+        "enum": [
+          "section_1",
+          "section_2",
+          "section_1A",
+          "section_1B"
+        ],
+        "type": "string"
+      },
+      "PackagingGroupEnum": {
+        "enum": [
+          "i",
+          "ii",
+          "iii"
+        ],
+        "type": "string"
       },
       "PickupConfirmation": {
         "type": "object",
@@ -3072,6 +3091,92 @@
         "additionalProperties": false,
         "description": "This model represents a window of time a pickup could be made."
       },
+      "Products": {
+        "required": [
+          "value"
+        ],
+        "type": "object",
+        "properties": {
+          "description": {
+            "type": "string",
+            "description": "A user specified free form string describing this customs item. If the field is absent the user has\r\nnot specified a description.",
+            "nullable": true
+          },
+          "quantity": {
+            "type": "integer",
+            "description": "The user specified count of items in this declaration. This value should be 1 or greater",
+            "format": "int32"
+          },
+          "value": {
+            "required": [
+              "currency",
+              "amount"
+            ],
+            "type": "object",
+            "properties": {
+              "amount": {
+                "type": "string",
+                "description": "Decimal currency value, as a string."
+              },
+              "currency": {
+                "type": "string",
+                "description": "Alpha-3 currency code complying with ISO 4217."
+              }
+            },
+            "description": "The user specified declared customs value of this customs item. Generally, this value needs to be greater\r\nthan 0 to be accepted through customs.",
+            "nullable": true
+          },
+          "country_of_origin": {
+            "type": "string",
+            "description": "The user specified declared country of origin of this customs item.",
+            "nullable": true
+          },
+          "harmonized_tariff_code": {
+            "type": "string",
+            "description": "The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information.",
+            "nullable": true
+          },
+          "sku": {
+            "type": "string",
+            "description": "The user specified SKU of this customs item. This field is completely free form.",
+            "nullable": true
+          },
+          "sku_description": {
+            "type": "string",
+            "description": "The user specified SKU description of this customs item. This field is completely free form.",
+            "nullable": true
+          },
+          "item_weight": {
+            "$ref": "#/components/schemas/WeightDetails"
+          },
+          "product_url": {
+            "type": "string",
+            "description": "A link to the item being shipped on the seller's website, used by customs officials\r\nto visually compare the item in the package to the available photo on the website.",
+            "nullable": true
+          },
+          "vat_rate": {
+            "type": "number",
+            "description": "The VAT rate applicable to the item being shipped, expressed as a decimal value between 0 and 1.",
+            "format": "double",
+            "nullable": true
+          },
+          "mid_code": {
+            "type": "string",
+            "description": "The Manufacturer Identification Code (MID). It is ussed as an alternative to the full\r\nname and address of a manufacturer, shipper or exporter and is always required for\r\nU.S. formal customs entries.",
+            "nullable": true
+          },
+          "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 the product information for a single item."
+      },
       "PudoLocation": {
         "required": [
           "postal_code",
@@ -3234,6 +3339,15 @@
         "additionalProperties": false,
         "description": "This model represents the successful response for a registration request."
       },
+      "RegulationLevelEnum": {
+        "enum": [
+          "lightly_regulated",
+          "fully_regulated",
+          "limited_quantities",
+          "excepted_quantity"
+        ],
+        "type": "string"
+      },
       "RelayPoint": {
         "required": [
           "opening_times",
@@ -3790,7 +3904,11 @@
           "pccc",
           "oss",
           "passport",
-          "abn"
+          "abn",
+          "nif",
+          "inn",
+          "cpf",
+          "cnpj"
         ],
         "type": "string",
         "description": "Specifies the supported tax identification types."
@@ -4115,6 +4233,15 @@
         "additionalProperties": false,
         "description": "This model represents the successful response from a tracking request."
       },
+      "TransportMeanEnum": {
+        "enum": [
+          "ground",
+          "water",
+          "cargo_aircraft_only",
+          "passenger_aircraft"
+        ],
+        "type": "string"
+      },
       "UpdateMethods": {
         "enum": [
           "append",

package/src/models/insurance-providers.ts

@@ -4,4 +4,6 @@ export enum InsuranceProviders {
   ShipStation = 'ShipStation',
   Carrier = 'Carrier',
   External = 'External',
+  XCover = 'XCover',
+  ParcelGuard = 'ParcelGuard',
 }

package/src/models/package.ts

@@ -3,7 +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';
+import { Products } from './products';
 
 /** @description Basic structure for a package */
 export class Package {
@@ -21,6 +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[];
+  /** @description List of products goods model associated with this package passed to the carrier. */
+  products?: Products[];
 }

package/src/models/products.ts

@@ -0,0 +1,31 @@
+import { WeightDetails } from './units/weight-details';
+import { Currency } from './currency';
+import { DangerousGoods } from './dangerous-good/dangerous-goods';
+
+/** @description Basic structure for a product */
+export class Products {
+  /** @description A user specified free form string describing this customs item. If the field is absent the user has not specified a description */
+  description?: string;
+  /** @description The user specified count of items in this declaration. This value should be 1 or greater */
+  quantity?: number;
+  /** @description The user specified declared customs value of this customs item. Generally, this value needs to be greater than 0 to be accepted through customs */
+  value?: Currency;
+  /** @description The user specified declared country of origin of this customs item */
+  country_of_origin?: string;
+  /** @description The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information */
+  harmonized_tariff_code?: string;
+  /** @description The user specified SKU of this customs item. This field is completely free form. */
+  sku?: string;
+  /** @description The user specified SKU description of this customs item. This field is completely free form. */
+  sku_description?: string;
+  /** @description Detailed information about the weight of this item */
+  item_weight?: WeightDetails;
+  /** @description A link to the item being shipped on the seller's website, used by customs officials to visually compare the item in the package to the available photo on the website. */
+  product_url?: string;
+  /** @description The VAT rate applicable to the item being shipped, expressed as a decimal value between 0 and 1. */
+  vat_rate?: number;
+  /** @description The Manufacturer Identification Code (MID). It is ussed as an alternative to the full name and address of a manufacturer, shipper or exporter and is always required for U.S. formal customs entries. */
+  mid_code?: string;
+  /** @description List of dangerous goods model associated with this package passed to the carrier. */
+  dangerous_goods?: DangerousGoods[];
+}