@shipengine/connect-carrier-api 4.11.11 → 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/lib/models/tracking/track-event-schema.js

@@ -10,6 +10,7 @@ exports.TrackEventSchema = joi_1.default.object({
     event_datetime: joi_1.default.string().optional().empty().isoDate(),
     event_datetime_local: joi_1.default.string().optional().empty().isoDate(),
     event_code: joi_1.default.string().optional().empty(),
+    carrier_detail_code: joi_1.default.string().optional().empty(),
     description: joi_1.default.string().optional().empty(),
     city: joi_1.default.string().optional().empty(),
     state: joi_1.default.string().optional().empty(),

package/lib/models/tracking/track-event-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"track-event-schema.js","sourceRoot":"","sources":["../../../src/models/tracking/track-event-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,uDAAkD;AAClD,yFAAmF;AACnF,uGAAgG;AAEnF,QAAA,gBAAgB,GAAG,aAAG,CAAC,MAAM,CAAC;IACzC,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACzD,oBAAoB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC/D,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5C,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACxC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACxC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACvC,GAAG,EAAE,+BAAa,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,gEAA6B,CAAC,QAAQ,EAAE;IACrD,kBAAkB,EAAE,6EAAmC,CAAC,QAAQ,EAAE;CACnE,CAAC,CAAC"}
+{"version":3,"file":"track-event-schema.js","sourceRoot":"","sources":["../../../src/models/tracking/track-event-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,uDAAkD;AAClD,yFAAmF;AACnF,uGAAgG;AAEnF,QAAA,gBAAgB,GAAG,aAAG,CAAC,MAAM,CAAC;IACzC,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACzD,oBAAoB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC/D,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3C,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACpD,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5C,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACxC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACxC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACvC,GAAG,EAAE,+BAAa,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,gEAA6B,CAAC,QAAQ,EAAE;IACrD,kBAAkB,EAAE,6EAAmC,CAAC,QAAQ,EAAE;CACnE,CAAC,CAAC"}

package/lib/models/tracking/track-event.d.ts

@@ -7,8 +7,10 @@ export declare class TrackEvent {
     event_datetime?: string;
     /** @description Most providers do not provide tracking events in UTC, and without time zone or geo information its hard to deduce. */
     event_datetime_local?: string;
-    /** @description Carrier's specific event code */
+    /** @description If the carrier returns both a generic and a specific event code, this field should contain the generic value while `carrier_detail_code` should contain the specific value. Otherwise, this field contains the carrier's specific event code. */
     event_code?: string;
+    /** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
+    carrier_detail_code?: string;
     /** @description Description of the package status at this event */
     description?: string;
     /** @description City or Locality for this event */

package/lib/models/tracking/track-event.js

@@ -7,8 +7,10 @@ class TrackEvent {
     event_datetime;
     /** @description Most providers do not provide tracking events in UTC, and without time zone or geo information its hard to deduce. */
     event_datetime_local;
-    /** @description Carrier's specific event code */
+    /** @description If the carrier returns both a generic and a specific event code, this field should contain the generic value while `carrier_detail_code` should contain the specific value. Otherwise, this field contains the carrier's specific event code. */
     event_code;
+    /** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
+    carrier_detail_code;
     /** @description Description of the package status at this event */
     description;
     /** @description City or Locality for this event */

package/lib/models/tracking/track-event.js.map

@@ -1 +1 @@
-{"version":3,"file":"track-event.js","sourceRoot":"","sources":["../../../src/models/tracking/track-event.ts"],"names":[],"mappings":";;;AAIA,uDAAuD;AACvD,MAAa,UAAU;IACrB,yHAAyH;IACzH,cAAc,CAAU;IACxB,sIAAsI;IACtI,oBAAoB,CAAU;IAC9B,iDAAiD;IACjD,UAAU,CAAU;IACpB,mEAAmE;IACnE,WAAW,CAAU;IACrB,mDAAmD;IACnD,IAAI,CAAU;IACd,qCAAqC;IACrC,KAAK,CAAU;IACf,sCAAsC;IACtC,WAAW,CAAU;IACrB,0CAA0C;IAC1C,OAAO,CAAU;IACjB,sEAAsE;IACtE,OAAO,CAAU;IACjB,8EAA8E;IAC9E,MAAM,CAAU;IAChB,yCAAyC;IACzC,GAAG,CAAW;IACd,iNAAiN;IACjN,WAAW,CAA2B;IACtC,+FAA+F;IAC/F,kBAAkB,CAAiC;CACpD;AA3BD,gCA2BC"}
+{"version":3,"file":"track-event.js","sourceRoot":"","sources":["../../../src/models/tracking/track-event.ts"],"names":[],"mappings":";;;AAIA,uDAAuD;AACvD,MAAa,UAAU;IACrB,yHAAyH;IACzH,cAAc,CAAU;IACxB,sIAAsI;IACtI,oBAAoB,CAAU;IAC9B,iQAAiQ;IACjQ,UAAU,CAAU;IACpB,kIAAkI;IAClI,mBAAmB,CAAU;IAC7B,mEAAmE;IACnE,WAAW,CAAU;IACrB,mDAAmD;IACnD,IAAI,CAAU;IACd,qCAAqC;IACrC,KAAK,CAAU;IACf,sCAAsC;IACtC,WAAW,CAAU;IACrB,0CAA0C;IAC1C,OAAO,CAAU;IACjB,sEAAsE;IACtE,OAAO,CAAU;IACjB,8EAA8E;IAC9E,MAAM,CAAU;IAChB,yCAAyC;IACzC,GAAG,CAAW;IACd,iNAAiN;IACjN,WAAW,CAA2B;IACtC,+FAA+F;IAC/F,kBAAkB,CAAiC;CACpD;AA7BD,gCA6BC"}

package/lib/models/tracking/tracking-info-schema.js

@@ -14,6 +14,7 @@ exports.TrackingInfoSchema = joi_1.default.object({
     standardized_status_code: standardized_status_codes_schema_1.StandardizedStatusCodesSchema,
     standardized_status_detail_code: standardized_status_detail_codes_schema_1.StandardizedStatusDetailCodesSchema,
     carrier_status_code: joi_1.default.string().optional().empty(),
+    carrier_detail_code: joi_1.default.string().optional().empty(),
     carrier_status_description: joi_1.default.string().optional().empty(),
     shipped_datetime: joi_1.default.string().optional().empty().isoDate(),
     estimated_delivery_datetime: joi_1.default.string().optional().empty(),

package/lib/models/tracking/tracking-info-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"tracking-info-schema.js","sourceRoot":"","sources":["../../../src/models/tracking/tracking-info-schema.ts"],"names":[],"mappings":";;;;AAAA,yFAAmF;AACnF,uGAAgG;AAChG,kEAA8D;AAC9D,qDAAiD;AACjD,6DAAwD;AACxD,sDAAsB;AAET,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,wBAAwB,EAAE,gEAA6B;IACvD,+BAA+B,EAAE,6EAAmC;IACpE,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACpD,0BAA0B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3D,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC3D,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5D,wBAAwB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACnE,4BAA4B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7D,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACvC,UAAU,EAAE,oCAAgB,CAAC,QAAQ,EAAE;IACvC,OAAO,EAAE,8BAAa,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC1C,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9C,MAAM,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,qCAAgB,CAAC;IACtD,gBAAgB,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAClD,qBAAqB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtD,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACnD,CAAC,CAAC,EAAE,CAAC,0BAA0B,EAAE,iCAAiC,CAAC,CAAC"}
+{"version":3,"file":"tracking-info-schema.js","sourceRoot":"","sources":["../../../src/models/tracking/tracking-info-schema.ts"],"names":[],"mappings":";;;;AAAA,yFAAmF;AACnF,uGAAgG;AAChG,kEAA8D;AAC9D,qDAAiD;AACjD,6DAAwD;AACxD,sDAAsB;AAET,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,wBAAwB,EAAE,gEAA6B;IACvD,+BAA+B,EAAE,6EAAmC;IACpE,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACpD,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACpD,0BAA0B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3D,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC3D,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5D,wBAAwB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACnE,4BAA4B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7D,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACvC,UAAU,EAAE,oCAAgB,CAAC,QAAQ,EAAE;IACvC,OAAO,EAAE,8BAAa,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC1C,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9C,MAAM,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,qCAAgB,CAAC;IACtD,gBAAgB,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAClD,qBAAqB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtD,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACnD,CAAC,CAAC,EAAE,CAAC,0BAA0B,EAAE,iCAAiC,CAAC,CAAC"}

package/lib/models/tracking/tracking-info.d.ts

@@ -13,8 +13,10 @@ export declare class TrackingInfo {
     standardized_status_code?: StandardizedStatusCodes;
     /** @description This represents the ShipEngine supported status detil codes for a shipment. */
     standardized_status_detail_code?: StandardizedStatusDetailCodes;
-    /** @description The carrier specific status code of this shipment's tracking status. */
+    /** @description If the carrier returns both a generic and a specific tracking status code for the shipment, this field should contain the generic value while `carrier_detail_code` should contain the specific value. Otherwise, this field contains the carrier's specific status code. */
     carrier_status_code?: string;
+    /** @description Optional field for the carrier's specific tracking status code when `carrier_status_code` is populated with a generic status code. */
+    carrier_detail_code?: string;
     /** @description The human readable description of this shipment's tracking status. */
     carrier_status_description?: string;
     /** @description When the package(s) in this shipment were turned over to the carrier. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */

package/lib/models/tracking/tracking-info.js

@@ -11,8 +11,10 @@ class TrackingInfo {
     standardized_status_code;
     /** @description This represents the ShipEngine supported status detil codes for a shipment. */
     standardized_status_detail_code;
-    /** @description The carrier specific status code of this shipment's tracking status. */
+    /** @description If the carrier returns both a generic and a specific tracking status code for the shipment, this field should contain the generic value while `carrier_detail_code` should contain the specific value. Otherwise, this field contains the carrier's specific status code. */
     carrier_status_code;
+    /** @description Optional field for the carrier's specific tracking status code when `carrier_status_code` is populated with a generic status code. */
+    carrier_detail_code;
     /** @description The human readable description of this shipment's tracking status. */
     carrier_status_description;
     /** @description When the package(s) in this shipment were turned over to the carrier. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */

package/lib/models/tracking/tracking-info.js.map

@@ -1 +1 @@
-{"version":3,"file":"tracking-info.js","sourceRoot":"","sources":["../../../src/models/tracking/tracking-info.ts"],"names":[],"mappings":";;;AAMA,4DAA4D;AAC5D,MAAa,YAAY;IACvB,kFAAkF;IAClF,YAAY,CAAU;IACtB,+EAA+E;IAC/E,eAAe,CAAU;IACzB,iNAAiN;IACjN,wBAAwB,CAA2B;IACnD,+FAA+F;IAC/F,+BAA+B,CAAiC;IAChE,wFAAwF;IACxF,mBAAmB,CAAU;IAC7B,sFAAsF;IACtF,0BAA0B,CAAU;IACpC,4JAA4J;IAC5J,gBAAgB,CAAU;IAC1B,wKAAwK;IACxK,2BAA2B,CAAU;IACrC,yJAAyJ;IACzJ,wBAAwB,CAAU;IAClC,0FAA0F;IAC1F,4BAA4B,CAAU;IACtC,0FAA0F;IAC1F,MAAM,CAAU;IAChB,8FAA8F;IAC9F,UAAU,CAAc;IACxB,yDAAyD;IACzD,OAAO,CAAW;IAClB,+CAA+C;IAC/C,SAAS,CAAU;IACnB,4EAA4E;IAC5E,aAAa,CAAU;IACvB,+DAA+D;IAC/D,MAAM,CAAgB;IACtB,4EAA4E;IAC5E,gBAAgB,CAAW;IAC3B,mGAAmG;IACnG,qBAAqB,CAAU;IAC/B,6FAA6F;IAC7F,iBAAiB,CAAU;CAC5B;AAvCD,oCAuCC"}
+{"version":3,"file":"tracking-info.js","sourceRoot":"","sources":["../../../src/models/tracking/tracking-info.ts"],"names":[],"mappings":";;;AAMA,4DAA4D;AAC5D,MAAa,YAAY;IACvB,kFAAkF;IAClF,YAAY,CAAU;IACtB,+EAA+E;IAC/E,eAAe,CAAU;IACzB,iNAAiN;IACjN,wBAAwB,CAA2B;IACnD,+FAA+F;IAC/F,+BAA+B,CAAiC;IAChE,6RAA6R;IAC7R,mBAAmB,CAAU;IAC7B,sJAAsJ;IACtJ,mBAAmB,CAAU;IAC7B,sFAAsF;IACtF,0BAA0B,CAAU;IACpC,4JAA4J;IAC5J,gBAAgB,CAAU;IAC1B,wKAAwK;IACxK,2BAA2B,CAAU;IACrC,yJAAyJ;IACzJ,wBAAwB,CAAU;IAClC,0FAA0F;IAC1F,4BAA4B,CAAU;IACtC,0FAA0F;IAC1F,MAAM,CAAU;IAChB,8FAA8F;IAC9F,UAAU,CAAc;IACxB,yDAAyD;IACzD,OAAO,CAAW;IAClB,+CAA+C;IAC/C,SAAS,CAAU;IACnB,4EAA4E;IAC5E,aAAa,CAAU;IACvB,+DAA+D;IAC/D,MAAM,CAAgB;IACtB,4EAA4E;IAC5E,gBAAgB,CAAW;IAC3B,mGAAmG;IACnG,qBAAqB,CAAU;IAC/B,6FAA6F;IAC7F,iBAAiB,CAAU;CAC5B;AAzCD,oCAyCC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.11.11",
+  "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.8"
+    "version": "1.25.0"
   },
   "paths": {
     "/Register": {
@@ -554,7 +554,7 @@
                 "examples": {
                   "Delivered with Event History": {
                     "summary": "Delivered with Event History",
-                    "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"DE","carrier_status_code":"11","carrier_status_description":"Delivered","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","weight":500.0,"dimensions":{"length":10.0,"width":10.0,"height":10.0},"service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"events":[{"event_datetime":"2021-08-08T21:15:00Z","event_datetime_local":"2021-08-08T16:15:00","event_code":"3","description":"Order Processed: Ready for UPS","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.31,"long":-97.74},"status_code":"AC"},{"event_datetime":"2021-08-09T09:15:00Z","event_datetime_local":"2021-08-09T04:15:00","event_code":"5","description":"In Transit","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.2,"long":-97.66},"status_code":"IT"},{"event_datetime":"2021-08-10T09:15:00Z","event_datetime_local":"2021-08-10T04:15:00","event_code":"6","description":"On Vehicle for Delivery","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-10T15:15:00Z","event_datetime_local":"2021-08-10T10:15:00","event_code":"21","description":"On Vehicle for Delivery Today","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-10T21:15:00Z","event_datetime_local":"2021-08-10T16:15:00","event_code":"22","description":"First Attempt Made","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"AT"},{"event_datetime":"2021-08-11T03:15:00Z","event_datetime_local":"2021-08-10T22:15:00","event_code":"21","description":"On Vehicle for Delivery Today","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-11T21:15:00Z","event_datetime_local":"2021-08-11T16:15:00","event_code":"11","description":"Delivered","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"DE"}],"shipping_problem":false,"carrierEnum":0}}
+                    "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"DE","carrier_status_code":"D","carrier_detail_code":"FS","carrier_status_description":"Delivered","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","weight":500.0,"dimensions":{"length":10.0,"width":10.0,"height":10.0},"service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"events":[{"event_datetime":"2021-08-08T21:15:00Z","event_datetime_local":"2021-08-08T16:15:00","event_code":"M","carrier_detail_code":"DP","description":"Order Processed: Ready for UPS","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.31,"long":-97.74},"status_code":"AC"},{"event_datetime":"2021-08-09T09:15:00Z","event_datetime_local":"2021-08-09T04:15:00","event_code":"I","carrier_detail_code":"MY","description":"In Transit","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.2,"long":-97.66},"status_code":"IT"},{"event_datetime":"2021-08-10T09:15:00Z","event_datetime_local":"2021-08-10T04:15:00","event_code":"I","carrier_detail_code":"DS","description":"On Vehicle for Delivery","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-10T15:15:00Z","event_datetime_local":"2021-08-10T10:15:00","event_code":"I","carrier_detail_code":"OF","description":"On Vehicle for Delivery Today","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-10T21:15:00Z","event_datetime_local":"2021-08-10T16:15:00","event_code":"I","carrier_detail_code":"QS","description":"First Attempt Made","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"AT"},{"event_datetime":"2021-08-11T03:15:00Z","event_datetime_local":"2021-08-10T22:15:00","event_code":"I","carrier_detail_code":"OF","description":"On Vehicle for Delivery Today","city":"Los Angeles","state":"CA","postal_code":"90045","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"IT"},{"event_datetime":"2021-08-11T21:15:00Z","event_datetime_local":"2021-08-11T16:15:00","event_code":"D","carrier_detail_code":"FS","description":"Delivered","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"DE"}],"shipping_problem":false,"carrierEnum":0}}
                   },
                   "Not Yet in System": {
                     "summary": "Not Yet in System",
@@ -562,7 +562,7 @@
                   },
                   "Fatal Exception": {
                     "summary": "Fatal Exception",
-                    "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"EX","carrier_status_code":"64","carrier_status_description":"Delivery Refused","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","weight":500.0,"dimensions":{"length":10.0,"width":10.0,"height":10.0},"service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"events":[{"event_datetime":"2021-08-09T09:15:00Z","event_datetime_local":"2021-08-09T04:15:00","event_code":"5","description":"In Transit","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.2,"long":-97.66},"status_code":"IT"},{"event_datetime":"2021-08-11T21:15:00Z","event_datetime_local":"2021-08-11T16:15:00","event_code":"59","description":"Delivery Refused","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"EX"}],"shipping_problem":false,"carrierEnum":0}}
+                    "value": {"tracking_info":{"carrier_name":"UPS","tracking_number":"12345678901234567890","standardized_status_code":"EX","carrier_status_code":"X","carrier_detail_code":"KR","carrier_status_description":"Delivery Refused","estimated_delivery_datetime":"2021-08-11T00:00:00","actual_delivery_datetime":"2021-08-11T21:15:00Z","weight":500.0,"dimensions":{"length":10.0,"width":10.0,"height":10.0},"service":{"code":"03","name":"UPS® Ground"},"packaging":"package","package_count":1,"events":[{"event_datetime":"2021-08-09T09:15:00Z","event_datetime_local":"2021-08-09T04:15:00","event_code":"I","carrier_detail_code":"MY","description":"In Transit","city":"Austin","state":"TX","postal_code":"78756","country":"US","geo":{"lat":30.2,"long":-97.66},"status_code":"IT"},{"event_datetime":"2021-08-11T21:15:00Z","event_datetime_local":"2021-08-11T16:15:00","event_code":"X","carrier_detail_code":"KR","description":"Delivery Refused","city":"El Segundo","state":"CA","postal_code":"90245","country":"US","geo":{"lat":33.95,"long":-118.38},"status_code":"EX"}],"shipping_problem":false,"carrierEnum":0}}
                   }
                 }
               }
@@ -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"
@@ -4463,7 +4464,12 @@
           },
           "event_code": {
             "type": "string",
-            "description": "Carrier's specific event code",
+            "description": "If the carrier returns both a generic and a specific event code, this field should contain the generic value while CarrierApi.Common.Models.Tracking.TrackEvent.CarrierDetailCode should contain the specific value. Otherwise, this field contains the carrier's specific event code.",
+            "nullable": true
+          },
+          "carrier_detail_code": {
+            "type": "string",
+            "description": "Optional field for the carrier's specific event code when CarrierApi.Common.Models.Tracking.TrackEvent.EventCode is populated with a generic event code.",
             "nullable": true
           },
           "description": {
@@ -4570,7 +4576,12 @@
           },
           "carrier_status_code": {
             "type": "string",
-            "description": "The carrier specific status code of this shipment's tracking status.",
+            "description": "If the carrier returns both a generic and a specific tracking status code for the shipment, this field should contain the generic value while CarrierApi.Common.Models.Tracking.TrackingInfo.CarrierDetailCode should contain the specific value. Otherwise, this field contains the carrier's specific status code.",
+            "nullable": true
+          },
+          "carrier_detail_code": {
+            "type": "string",
+            "description": "Optional field for the carrier's specific tracking status code when CarrierApi.Common.Models.Tracking.TrackingInfo.CarrierStatusCode is populated with a generic status code.",
             "nullable": true
           },
           "carrier_status_description": {
@@ -4707,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",
@@ -5139,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;
+}

package/src/models/tracking/track-event-schema.ts

@@ -7,6 +7,7 @@ export const TrackEventSchema = Joi.object({
   event_datetime: Joi.string().optional().empty().isoDate(),
   event_datetime_local: Joi.string().optional().empty().isoDate(),
   event_code: Joi.string().optional().empty(),
+  carrier_detail_code: Joi.string().optional().empty(),
   description: Joi.string().optional().empty(),
   city: Joi.string().optional().empty(),
   state: Joi.string().optional().empty(),

package/src/models/tracking/track-event.ts

@@ -8,8 +8,10 @@ export class TrackEvent {
   event_datetime?: string;
   /** @description Most providers do not provide tracking events in UTC, and without time zone or geo information its hard to deduce. */
   event_datetime_local?: string;
-  /** @description Carrier's specific event code */
+  /** @description If the carrier returns both a generic and a specific event code, this field should contain the generic value while `carrier_detail_code` should contain the specific value. Otherwise, this field contains the carrier's specific event code. */
   event_code?: string;
+  /** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
+  carrier_detail_code?: string;
   /** @description Description of the package status at this event */
   description?: string;
   /** @description City or Locality for this event */

package/src/models/tracking/tracking-info-schema.ts

@@ -11,6 +11,7 @@ export const TrackingInfoSchema = Joi.object({
   standardized_status_code: StandardizedStatusCodesSchema,
   standardized_status_detail_code: StandardizedStatusDetailCodesSchema,
   carrier_status_code: Joi.string().optional().empty(),
+  carrier_detail_code: Joi.string().optional().empty(),
   carrier_status_description: Joi.string().optional().empty(),
   shipped_datetime: Joi.string().optional().empty().isoDate(),
   estimated_delivery_datetime: Joi.string().optional().empty(),

package/src/models/tracking/tracking-info.ts

@@ -14,8 +14,10 @@ export class TrackingInfo {
   standardized_status_code?: StandardizedStatusCodes;
   /** @description This represents the ShipEngine supported status detil codes for a shipment. */
   standardized_status_detail_code?: StandardizedStatusDetailCodes;
-  /** @description The carrier specific status code of this shipment's tracking status. */
+  /** @description If the carrier returns both a generic and a specific tracking status code for the shipment, this field should contain the generic value while `carrier_detail_code` should contain the specific value. Otherwise, this field contains the carrier's specific status code. */
   carrier_status_code?: string;
+  /** @description Optional field for the carrier's specific tracking status code when `carrier_status_code` is populated with a generic status code. */
+  carrier_detail_code?: string;
   /** @description The human readable description of this shipment's tracking status. */
   carrier_status_description?: string;
   /** @description When the package(s) in this shipment were turned over to the carrier. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */