@shipengine/connect-carrier-api 4.11.12 → 4.12.0

package/lib/models/customs/customs.d.ts

@@ -5,6 +5,7 @@ import { Currency } from '../currency';
 import { TermsOfTradeCode } from '../inconterms/terms-of-trade-code';
 import { ImporterOfRecord } from '../importer-records/importer-of-record';
 import { CustomsCharges } from './customs-charges';
+import { EstimatedImportCharges } from './estimated-import-charges';
 /** @description Basic structure for a customs declaration */
 export declare class Customs {
     /** @description Indicates the type of contents associated with this shipment */
@@ -29,4 +30,6 @@ export declare class Customs {
     contents_explanation?: String;
     /**@description:   An EDN is a number which is nine alphanumeric characters long and issued by the Australian Customs (Australian Border Force) in exchange for the information that an exporter shares with them.  */
     export_declaration_number?: String;
+    /**@description:   Estimated charges related to importing goods, such as customs duties, taxes, and other import-related fees. Depending on carrier, if provided they will be displayed on the Commercial Invoice.  */
+    estimated_import_charges?: EstimatedImportCharges;
 }

package/lib/models/customs/customs.js

@@ -25,6 +25,8 @@ class Customs {
     contents_explanation;
     /**@description:   An EDN is a number which is nine alphanumeric characters long and issued by the Australian Customs (Australian Border Force) in exchange for the information that an exporter shares with them.  */
     export_declaration_number;
+    /**@description:   Estimated charges related to importing goods, such as customs duties, taxes, and other import-related fees. Depending on carrier, if provided they will be displayed on the Commercial Invoice.  */
+    estimated_import_charges;
 }
 exports.Customs = Customs;
 //# sourceMappingURL=customs.js.map

package/lib/models/customs/customs.js.map

@@ -1 +1 @@
-{"version":3,"file":"customs.js","sourceRoot":"","sources":["../../../src/models/customs/customs.ts"],"names":[],"mappings":";;;AAQA,6DAA6D;AAC7D,MAAa,OAAO;IAClB,gFAAgF;IAChF,QAAQ,CAAuB;IAC/B,+FAA+F;IAC/F,YAAY,CAAsB;IAClC,0FAA0F;IAC1F,aAAa,CAAiB;IAC9B,sJAAsJ;IACtJ,0BAA0B,CAAY;IACtC,iJAAiJ;IACjJ,WAAW,CAAY;IACvB,gFAAgF;IAChF,WAAW,CAAU;IACrB,iGAAiG;IACjG,mBAAmB,CAAoB;IACvC,oGAAoG;IACpG,kBAAkB,CAAoB;IACtC,oDAAoD;IACpD,0BAA0B,CAAkB;IAC5C,sDAAsD;IACtD,oBAAoB,CAAU;IAC9B,sNAAsN;IACtN,yBAAyB,CAAU;CACpC;AAvBD,0BAuBC"}
+{"version":3,"file":"customs.js","sourceRoot":"","sources":["../../../src/models/customs/customs.ts"],"names":[],"mappings":";;;AASA,6DAA6D;AAC7D,MAAa,OAAO;IAClB,gFAAgF;IAChF,QAAQ,CAAuB;IAC/B,+FAA+F;IAC/F,YAAY,CAAsB;IAClC,0FAA0F;IAC1F,aAAa,CAAiB;IAC9B,sJAAsJ;IACtJ,0BAA0B,CAAY;IACtC,iJAAiJ;IACjJ,WAAW,CAAY;IACvB,gFAAgF;IAChF,WAAW,CAAU;IACrB,iGAAiG;IACjG,mBAAmB,CAAoB;IACvC,oGAAoG;IACpG,kBAAkB,CAAoB;IACtC,oDAAoD;IACpD,0BAA0B,CAAkB;IAC5C,sDAAsD;IACtD,oBAAoB,CAAU;IAC9B,sNAAsN;IACtN,yBAAyB,CAAU;IACnC,sNAAsN;IACtN,wBAAwB,CAA0B;CACnD;AAzBD,0BAyBC"}

package/lib/models/customs/estimated-import-charges.d.ts

@@ -0,0 +1,8 @@
+import { Currency } from '../currency';
+/** @description Estimated charges related to importing goods, such as customs duties, taxes, and other import-related fees. Depending on carrier, if provided they will be displayed on the Commercial Invoice. */
+export declare class EstimatedImportCharges {
+    /** @description Estimated amount and currency of import taxes, such as Value-Added Tax (VAT) or Goods and Services Tax (GST). */
+    taxes?: Currency;
+    /** @description Estimated amount and currency of import duties. */
+    duties?: Currency;
+}

package/lib/models/customs/estimated-import-charges.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EstimatedImportCharges = void 0;
+/** @description Estimated charges related to importing goods, such as customs duties, taxes, and other import-related fees. Depending on carrier, if provided they will be displayed on the Commercial Invoice. */
+class EstimatedImportCharges {
+    /** @description Estimated amount and currency of import taxes, such as Value-Added Tax (VAT) or Goods and Services Tax (GST). */
+    taxes;
+    /** @description Estimated amount and currency of import duties. */
+    duties;
+}
+exports.EstimatedImportCharges = EstimatedImportCharges;
+//# sourceMappingURL=estimated-import-charges.js.map

package/lib/models/customs/estimated-import-charges.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"estimated-import-charges.js","sourceRoot":"","sources":["../../../src/models/customs/estimated-import-charges.ts"],"names":[],"mappings":";;;AAEA,mNAAmN;AACnN,MAAa,sBAAsB;IACjC,iIAAiI;IACjI,KAAK,CAAY;IACjB,mEAAmE;IACnE,MAAM,CAAY;CACnB;AALD,wDAKC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.11.12",
+  "version": "4.12.0",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",
@@ -44,7 +44,7 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@shipengine/connect-runtime": "^4.8.0",
+    "@shipengine/connect-runtime": "^4.9.1",
     "express": "^4.18.2",
     "winston": "^3.8.2"
   }

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.24.11"
+    "version": "1.25.0"
   },
   "paths": {
     "/Register": {
@@ -1812,6 +1812,9 @@
             "type": "string",
             "description": "An EDN is a number which is nine alphanumeric characters long and issued by the Australian Customs (Australian Border Force) in exchange for the information that an exporter shares with them.",
             "nullable": true
+          },
+          "estimated_import_charges": {
+            "$ref": "#/components/schemas/EstimatedImportCharges"
           }
         },
         "additionalProperties": false
@@ -2089,6 +2092,50 @@
         ],
         "type": "string"
       },
+      "EstimatedImportCharges": {
+        "type": "object",
+        "properties": {
+          "taxes": {
+            "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": "Estimated amount and currency of import taxes, such as Value-Added Tax (VAT) or Goods and Services Tax (GST).",
+            "nullable": true
+          },
+          "duties": {
+            "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": "Estimated amount and currency of import duties.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
       "ExampleRegisterRequest": {
         "type": "object",
         "additionalProperties": false
@@ -3076,51 +3123,6 @@
         ],
         "type": "string"
       },
-      "UnitOfMeasureEnum": {
-        "enum": [
-          "barrel",
-          "bundle",
-          "bag",
-          "bunch",
-          "box",
-          "bolt",
-          "butt",
-          "canister",
-          "centimeter",
-          "container",
-          "crate",
-          "case",
-          "carton",
-          "cylinder",
-          "dozen",
-          "each",
-          "envelope",
-          "feet",
-          "kilogram",
-          "kilograms",
-          "pound",
-          "pounds",
-          "liter",
-          "meter",
-          "number",
-          "packet",
-          "pallet",
-          "piece",
-          "pieces",
-          "proof_liters",
-          "package",
-          "pair",
-          "pairs",
-          "roll",
-          "set",
-          "square_meters",
-          "square_yards",
-          "tube",
-          "yard",
-          "other"
-        ],
-        "type": "string"
-      },
       "PaperlessDetails": {
         "type": "object",
         "properties": {
@@ -3477,7 +3479,6 @@
           },
           "guaranteed_delivery_days": {
             "type": "integer",
-            "description": "Guaranteed delivery days. The number of days it will take for the package to be delivered. <example>1</example>",
             "format": "int32",
             "nullable": true
           }
@@ -4432,14 +4433,14 @@
           },
           "start_window": {
             "type": "string",
-            "description": "The start of the window when the pickup could be made relative to the time_zone_iana. (ISO 8601 format, with local offset)",
+            "description": "The start of the window when the pickup could be made relative to the time_zone_iana. (ISO 8601 format,with offset)",
             "format": "date-time",
             "nullable": true,
             "example": "2021-08-20T14:38:36.859237-05:00"
           },
           "end_window": {
             "type": "string",
-            "description": "The end of the window when the pickup could be made relative to the time_zone_iana. (ISO 8601 format, with local offset)",
+            "description": "The end of the window when the pickup could be made relative to the time_zone_iana. (ISO 8601 format, with offset)",
             "format": "date-time",
             "nullable": true,
             "example": "2021-08-20T18:38:36.859237-05:00"
@@ -4717,6 +4718,51 @@
         ],
         "type": "string"
       },
+      "UnitOfMeasureEnum": {
+        "enum": [
+          "barrel",
+          "bundle",
+          "bag",
+          "bunch",
+          "box",
+          "bolt",
+          "butt",
+          "canister",
+          "centimeter",
+          "container",
+          "crate",
+          "case",
+          "carton",
+          "cylinder",
+          "dozen",
+          "each",
+          "envelope",
+          "feet",
+          "kilogram",
+          "kilograms",
+          "pound",
+          "pounds",
+          "liter",
+          "meter",
+          "number",
+          "packet",
+          "pallet",
+          "piece",
+          "pieces",
+          "proof_liters",
+          "package",
+          "pair",
+          "pairs",
+          "roll",
+          "set",
+          "square_meters",
+          "square_yards",
+          "tube",
+          "yard",
+          "other"
+        ],
+        "type": "string"
+      },
       "UpdateMethods": {
         "enum": [
           "append",
@@ -5149,4 +5195,4 @@
       "description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
     }
   ]
-}
+}

package/src/models/customs/customs.ts

@@ -5,6 +5,7 @@ import { Currency } from '../currency';
 import { TermsOfTradeCode } from '../inconterms/terms-of-trade-code';
 import { ImporterOfRecord } from '../importer-records/importer-of-record';
 import { CustomsCharges } from './customs-charges';
+import { EstimatedImportCharges } from './estimated-import-charges';
 
 /** @description Basic structure for a customs declaration */
 export class Customs {
@@ -30,4 +31,6 @@ export class Customs {
   contents_explanation?: String;
   /**@description:   An EDN is a number which is nine alphanumeric characters long and issued by the Australian Customs (Australian Border Force) in exchange for the information that an exporter shares with them.  */
   export_declaration_number?: String;
+  /**@description:   Estimated charges related to importing goods, such as customs duties, taxes, and other import-related fees. Depending on carrier, if provided they will be displayed on the Commercial Invoice.  */
+  estimated_import_charges?: EstimatedImportCharges;
 }

package/src/models/customs/estimated-import-charges.ts

@@ -0,0 +1,9 @@
+import { Currency } from '../currency';
+
+/** @description Estimated charges related to importing goods, such as customs duties, taxes, and other import-related fees. Depending on carrier, if provided they will be displayed on the Commercial Invoice. */
+export class EstimatedImportCharges {
+  /** @description Estimated amount and currency of import taxes, such as Value-Added Tax (VAT) or Goods and Services Tax (GST). */
+  taxes?: Currency;
+  /** @description Estimated amount and currency of import duties. */
+  duties?: Currency;
+}