@shipengine/connect-carrier-api 4.11.11 → 4.11.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. package/lib/models/tracking/track-event-schema.js +1 -0
  2. package/lib/models/tracking/track-event-schema.js.map +1 -1
  3. package/lib/models/tracking/track-event.d.ts +3 -1
  4. package/lib/models/tracking/track-event.js +3 -1
  5. package/lib/models/tracking/track-event.js.map +1 -1
  6. package/lib/models/tracking/tracking-info-schema.js +1 -0
  7. package/lib/models/tracking/tracking-info-schema.js.map +1 -1
  8. package/lib/models/tracking/tracking-info.d.ts +3 -1
  9. package/lib/models/tracking/tracking-info.js +3 -1
  10. package/lib/models/tracking/tracking-info.js.map +1 -1
  11. package/package.json +1 -1
  12. package/spec.json +15 -5
  13. package/src/models/tracking/track-event-schema.ts +1 -0
  14. package/src/models/tracking/track-event.ts +3 -1
  15. package/src/models/tracking/tracking-info-schema.ts +1 -0
  16. package/src/models/tracking/tracking-info.ts +3 -1
  17. package/tsconfig.tsbuildinfo +1 -1
package/lib/models/tracking/track-event-schema.js CHANGED
@@ -10,6 +10,7 @@ exports.TrackEventSchema = joi_1.default.object({
10
10
  event_datetime: joi_1.default.string().optional().empty().isoDate(),
11
11
  event_datetime_local: joi_1.default.string().optional().empty().isoDate(),
12
12
  event_code: joi_1.default.string().optional().empty(),
13
+ carrier_detail_code: joi_1.default.string().optional().empty(),
13
14
  description: joi_1.default.string().optional().empty(),
14
15
  city: joi_1.default.string().optional().empty(),
15
16
  state: joi_1.default.string().optional().empty(),
package/lib/models/tracking/track-event-schema.js.map CHANGED
@@ -1 +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"}
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,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 CHANGED
@@ -7,8 +7,10 @@ export declare class TrackEvent {
7
7
  event_datetime?: string;
8
8
  /** @description Most providers do not provide tracking events in UTC, and without time zone or geo information its hard to deduce. */
9
9
  event_datetime_local?: string;
10
- /** @description Carrier's specific event code */
10
+ /** @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. */
11
11
  event_code?: string;
12
+ /** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
13
+ carrier_detail_code?: string;
12
14
  /** @description Description of the package status at this event */
13
15
  description?: string;
14
16
  /** @description City or Locality for this event */
package/lib/models/tracking/track-event.js CHANGED
@@ -7,8 +7,10 @@ class TrackEvent {
7
7
  event_datetime;
8
8
  /** @description Most providers do not provide tracking events in UTC, and without time zone or geo information its hard to deduce. */
9
9
  event_datetime_local;
10
- /** @description Carrier's specific event code */
10
+ /** @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. */
11
11
  event_code;
12
+ /** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
13
+ carrier_detail_code;
12
14
  /** @description Description of the package status at this event */
13
15
  description;
14
16
  /** @description City or Locality for this event */
package/lib/models/tracking/track-event.js.map CHANGED
@@ -1 +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"}
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,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 CHANGED
@@ -14,6 +14,7 @@ exports.TrackingInfoSchema = joi_1.default.object({
14
14
  standardized_status_code: standardized_status_codes_schema_1.StandardizedStatusCodesSchema,
15
15
  standardized_status_detail_code: standardized_status_detail_codes_schema_1.StandardizedStatusDetailCodesSchema,
16
16
  carrier_status_code: joi_1.default.string().optional().empty(),
17
+ carrier_detail_code: joi_1.default.string().optional().empty(),
17
18
  carrier_status_description: joi_1.default.string().optional().empty(),
18
19
  shipped_datetime: joi_1.default.string().optional().empty().isoDate(),
19
20
  estimated_delivery_datetime: joi_1.default.string().optional().empty(),
package/lib/models/tracking/tracking-info-schema.js.map CHANGED
@@ -1 +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"}
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,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 CHANGED
@@ -13,8 +13,10 @@ export declare class TrackingInfo {
13
13
  standardized_status_code?: StandardizedStatusCodes;
14
14
  /** @description This represents the ShipEngine supported status detil codes for a shipment. */
15
15
  standardized_status_detail_code?: StandardizedStatusDetailCodes;
16
- /** @description The carrier specific status code of this shipment's tracking status. */
16
+ /** @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. */
17
17
  carrier_status_code?: string;
18
+ /** @description Optional field for the carrier's specific tracking status code when `carrier_status_code` is populated with a generic status code. */
19
+ carrier_detail_code?: string;
18
20
  /** @description The human readable description of this shipment's tracking status. */
19
21
  carrier_status_description?: string;
20
22
  /** @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 CHANGED
@@ -11,8 +11,10 @@ class TrackingInfo {
11
11
  standardized_status_code;
12
12
  /** @description This represents the ShipEngine supported status detil codes for a shipment. */
13
13
  standardized_status_detail_code;
14
- /** @description The carrier specific status code of this shipment's tracking status. */
14
+ /** @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. */
15
15
  carrier_status_code;
16
+ /** @description Optional field for the carrier's specific tracking status code when `carrier_status_code` is populated with a generic status code. */
17
+ carrier_detail_code;
16
18
  /** @description The human readable description of this shipment's tracking status. */
17
19
  carrier_status_description;
18
20
  /** @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 CHANGED
@@ -1 +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"}
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,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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipengine/connect-carrier-api",
3
- "version": "4.11.11",
3
+ "version": "4.11.12",
4
4
  "description": "This is the typescript/javascript definitions for carrier api",
5
5
  "homepage": "https://connect.shipengine.com",
6
6
  "main": "./lib/index.js",
package/spec.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "Shipping API",
5
5
  "description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
6
- "version": "1.24.8"
6
+ "version": "1.24.11"
7
7
  },
8
8
  "paths": {
9
9
  "/Register": {
@@ -554,7 +554,7 @@
554
554
  "examples": {
555
555
  "Delivered with Event History": {
556
556
  "summary": "Delivered with Event History",
557
- "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}}
557
+ "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}}
558
558
  },
559
559
  "Not Yet in System": {
560
560
  "summary": "Not Yet in System",
@@ -562,7 +562,7 @@
562
562
  },
563
563
  "Fatal Exception": {
564
564
  "summary": "Fatal Exception",
565
- "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}}
565
+ "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}}
566
566
  }
567
567
  }
568
568
  }
@@ -4463,7 +4463,12 @@
4463
4463
  },
4464
4464
  "event_code": {
4465
4465
  "type": "string",
4466
- "description": "Carrier's specific event code",
4466
+ "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.",
4467
+ "nullable": true
4468
+ },
4469
+ "carrier_detail_code": {
4470
+ "type": "string",
4471
+ "description": "Optional field for the carrier's specific event code when CarrierApi.Common.Models.Tracking.TrackEvent.EventCode is populated with a generic event code.",
4467
4472
  "nullable": true
4468
4473
  },
4469
4474
  "description": {
@@ -4570,7 +4575,12 @@
4570
4575
  },
4571
4576
  "carrier_status_code": {
4572
4577
  "type": "string",
4573
- "description": "The carrier specific status code of this shipment's tracking status.",
4578
+ "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.",
4579
+ "nullable": true
4580
+ },
4581
+ "carrier_detail_code": {
4582
+ "type": "string",
4583
+ "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.",
4574
4584
  "nullable": true
4575
4585
  },
4576
4586
  "carrier_status_description": {
package/src/models/tracking/track-event-schema.ts CHANGED
@@ -7,6 +7,7 @@ export const TrackEventSchema = Joi.object({
7
7
  event_datetime: Joi.string().optional().empty().isoDate(),
8
8
  event_datetime_local: Joi.string().optional().empty().isoDate(),
9
9
  event_code: Joi.string().optional().empty(),
10
+ carrier_detail_code: Joi.string().optional().empty(),
10
11
  description: Joi.string().optional().empty(),
11
12
  city: Joi.string().optional().empty(),
12
13
  state: Joi.string().optional().empty(),
package/src/models/tracking/track-event.ts CHANGED
@@ -8,8 +8,10 @@ export class TrackEvent {
8
8
  event_datetime?: string;
9
9
  /** @description Most providers do not provide tracking events in UTC, and without time zone or geo information its hard to deduce. */
10
10
  event_datetime_local?: string;
11
- /** @description Carrier's specific event code */
11
+ /** @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. */
12
12
  event_code?: string;
13
+ /** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
14
+ carrier_detail_code?: string;
13
15
  /** @description Description of the package status at this event */
14
16
  description?: string;
15
17
  /** @description City or Locality for this event */
package/src/models/tracking/tracking-info-schema.ts CHANGED
@@ -11,6 +11,7 @@ export const TrackingInfoSchema = Joi.object({
11
11
  standardized_status_code: StandardizedStatusCodesSchema,
12
12
  standardized_status_detail_code: StandardizedStatusDetailCodesSchema,
13
13
  carrier_status_code: Joi.string().optional().empty(),
14
+ carrier_detail_code: Joi.string().optional().empty(),
14
15
  carrier_status_description: Joi.string().optional().empty(),
15
16
  shipped_datetime: Joi.string().optional().empty().isoDate(),
16
17
  estimated_delivery_datetime: Joi.string().optional().empty(),
package/src/models/tracking/tracking-info.ts CHANGED
@@ -14,8 +14,10 @@ export class TrackingInfo {
14
14
  standardized_status_code?: StandardizedStatusCodes;
15
15
  /** @description This represents the ShipEngine supported status detil codes for a shipment. */
16
16
  standardized_status_detail_code?: StandardizedStatusDetailCodes;
17
- /** @description The carrier specific status code of this shipment's tracking status. */
17
+ /** @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. */
18
18
  carrier_status_code?: string;
19
+ /** @description Optional field for the carrier's specific tracking status code when `carrier_status_code` is populated with a generic status code. */
20
+ carrier_detail_code?: string;
19
21
  /** @description The human readable description of this shipment's tracking status. */
20
22
  carrier_status_description?: string;
21
23
  /** @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. */