@shipengine/connect-carrier-api 4.11.10 → 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 (25) hide show
  1. package/lib/models/customs/unit-of-measure-types.d.ts +83 -0
  2. package/lib/models/customs/unit-of-measure-types.js +88 -0
  3. package/lib/models/customs/unit-of-measure-types.js.map +1 -0
  4. package/lib/models/products.d.ts +3 -0
  5. package/lib/models/products.js +2 -0
  6. package/lib/models/products.js.map +1 -1
  7. package/lib/models/tracking/track-event-schema.js +1 -0
  8. package/lib/models/tracking/track-event-schema.js.map +1 -1
  9. package/lib/models/tracking/track-event.d.ts +3 -1
  10. package/lib/models/tracking/track-event.js +3 -1
  11. package/lib/models/tracking/track-event.js.map +1 -1
  12. package/lib/models/tracking/tracking-info-schema.js +1 -0
  13. package/lib/models/tracking/tracking-info-schema.js.map +1 -1
  14. package/lib/models/tracking/tracking-info.d.ts +3 -1
  15. package/lib/models/tracking/tracking-info.js +3 -1
  16. package/lib/models/tracking/tracking-info.js.map +1 -1
  17. package/package.json +1 -1
  18. package/spec.json +63 -5
  19. package/src/models/customs/unit-of-measure-types.ts +83 -0
  20. package/src/models/products.ts +3 -0
  21. package/src/models/tracking/track-event-schema.ts +1 -0
  22. package/src/models/tracking/track-event.ts +3 -1
  23. package/src/models/tracking/tracking-info-schema.ts +1 -0
  24. package/src/models/tracking/tracking-info.ts +3 -1
  25. package/tsconfig.tsbuildinfo +1 -1
package/lib/models/customs/unit-of-measure-types.d.ts ADDED
@@ -0,0 +1,83 @@
1
+ /** @description This attribute mentions the type of unit of measure */
2
+ export declare enum UnitOfMeasureTypes {
3
+ /** @description barrel */
4
+ Barrel = "barrel",
5
+ /** @description bundle */
6
+ Bundle = "bundle",
7
+ /** @description bag */
8
+ Bag = "bag",
9
+ /** @description bunch */
10
+ Bunch = "bunch",
11
+ /** @description box */
12
+ Box = "box",
13
+ /** @description bolt */
14
+ Bolt = "bolt",
15
+ /** @description butt */
16
+ Butt = "butt",
17
+ /** @description canister */
18
+ Canister = "canister",
19
+ /** @description centimeter */
20
+ Centimeter = "centimeter",
21
+ /** @description container */
22
+ Container = "container",
23
+ /** @description crate */
24
+ Crate = "crate",
25
+ /** @description case */
26
+ Case = "case",
27
+ /** @description carton */
28
+ Carton = "carton",
29
+ /** @description cylinder */
30
+ Cylinder = "cylinder",
31
+ /** @description dozen */
32
+ Dozen = "dozen",
33
+ /** @description each */
34
+ Each = "each",
35
+ /** @description envelope */
36
+ Envelope = "envelope",
37
+ /** @description feet */
38
+ Feet = "feet",
39
+ /** @description kilogram */
40
+ Kilogram = "kilogram",
41
+ /** @description kilograms */
42
+ Kilograms = "kilograms",
43
+ /** @description pound */
44
+ Pound = "pound",
45
+ /** @description pounds */
46
+ Pounds = "pounds",
47
+ /** @description liter */
48
+ Liter = "liter",
49
+ /** @description meter */
50
+ Meter = "meter",
51
+ /** @description number */
52
+ Number = "number",
53
+ /** @description packet */
54
+ Packet = "packet",
55
+ /** @description pallet */
56
+ Pallet = "pallet",
57
+ /** @description piece */
58
+ Piece = "piece",
59
+ /** @description pieces */
60
+ Pieces = "pieces",
61
+ /** @description proof_liters */
62
+ Proof_Liters = "proof_liters",
63
+ /** @description package */
64
+ Package = "package",
65
+ /** @description pair */
66
+ Pair = "pair",
67
+ /** @description pairs */
68
+ Pairs = "pairs",
69
+ /** @description roll */
70
+ Roll = "roll",
71
+ /** @description set */
72
+ Set = "set",
73
+ /** @description square_meters */
74
+ Square_Meters = "square_meters",
75
+ /** @description square_yards */
76
+ Square_Yards = "square_yards",
77
+ /** @description tube */
78
+ Tube = "tube",
79
+ /** @description yard */
80
+ Yard = "yard",
81
+ /** @description other */
82
+ Other = "other"
83
+ }
package/lib/models/customs/unit-of-measure-types.js ADDED
@@ -0,0 +1,88 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.UnitOfMeasureTypes = void 0;
4
+ /** @description This attribute mentions the type of unit of measure */
5
+ var UnitOfMeasureTypes;
6
+ (function (UnitOfMeasureTypes) {
7
+ /** @description barrel */
8
+ UnitOfMeasureTypes["Barrel"] = "barrel";
9
+ /** @description bundle */
10
+ UnitOfMeasureTypes["Bundle"] = "bundle";
11
+ /** @description bag */
12
+ UnitOfMeasureTypes["Bag"] = "bag";
13
+ /** @description bunch */
14
+ UnitOfMeasureTypes["Bunch"] = "bunch";
15
+ /** @description box */
16
+ UnitOfMeasureTypes["Box"] = "box";
17
+ /** @description bolt */
18
+ UnitOfMeasureTypes["Bolt"] = "bolt";
19
+ /** @description butt */
20
+ UnitOfMeasureTypes["Butt"] = "butt";
21
+ /** @description canister */
22
+ UnitOfMeasureTypes["Canister"] = "canister";
23
+ /** @description centimeter */
24
+ UnitOfMeasureTypes["Centimeter"] = "centimeter";
25
+ /** @description container */
26
+ UnitOfMeasureTypes["Container"] = "container";
27
+ /** @description crate */
28
+ UnitOfMeasureTypes["Crate"] = "crate";
29
+ /** @description case */
30
+ UnitOfMeasureTypes["Case"] = "case";
31
+ /** @description carton */
32
+ UnitOfMeasureTypes["Carton"] = "carton";
33
+ /** @description cylinder */
34
+ UnitOfMeasureTypes["Cylinder"] = "cylinder";
35
+ /** @description dozen */
36
+ UnitOfMeasureTypes["Dozen"] = "dozen";
37
+ /** @description each */
38
+ UnitOfMeasureTypes["Each"] = "each";
39
+ /** @description envelope */
40
+ UnitOfMeasureTypes["Envelope"] = "envelope";
41
+ /** @description feet */
42
+ UnitOfMeasureTypes["Feet"] = "feet";
43
+ /** @description kilogram */
44
+ UnitOfMeasureTypes["Kilogram"] = "kilogram";
45
+ /** @description kilograms */
46
+ UnitOfMeasureTypes["Kilograms"] = "kilograms";
47
+ /** @description pound */
48
+ UnitOfMeasureTypes["Pound"] = "pound";
49
+ /** @description pounds */
50
+ UnitOfMeasureTypes["Pounds"] = "pounds";
51
+ /** @description liter */
52
+ UnitOfMeasureTypes["Liter"] = "liter";
53
+ /** @description meter */
54
+ UnitOfMeasureTypes["Meter"] = "meter";
55
+ /** @description number */
56
+ UnitOfMeasureTypes["Number"] = "number";
57
+ /** @description packet */
58
+ UnitOfMeasureTypes["Packet"] = "packet";
59
+ /** @description pallet */
60
+ UnitOfMeasureTypes["Pallet"] = "pallet";
61
+ /** @description piece */
62
+ UnitOfMeasureTypes["Piece"] = "piece";
63
+ /** @description pieces */
64
+ UnitOfMeasureTypes["Pieces"] = "pieces";
65
+ /** @description proof_liters */
66
+ UnitOfMeasureTypes["Proof_Liters"] = "proof_liters";
67
+ /** @description package */
68
+ UnitOfMeasureTypes["Package"] = "package";
69
+ /** @description pair */
70
+ UnitOfMeasureTypes["Pair"] = "pair";
71
+ /** @description pairs */
72
+ UnitOfMeasureTypes["Pairs"] = "pairs";
73
+ /** @description roll */
74
+ UnitOfMeasureTypes["Roll"] = "roll";
75
+ /** @description set */
76
+ UnitOfMeasureTypes["Set"] = "set";
77
+ /** @description square_meters */
78
+ UnitOfMeasureTypes["Square_Meters"] = "square_meters";
79
+ /** @description square_yards */
80
+ UnitOfMeasureTypes["Square_Yards"] = "square_yards";
81
+ /** @description tube */
82
+ UnitOfMeasureTypes["Tube"] = "tube";
83
+ /** @description yard */
84
+ UnitOfMeasureTypes["Yard"] = "yard";
85
+ /** @description other */
86
+ UnitOfMeasureTypes["Other"] = "other";
87
+ })(UnitOfMeasureTypes || (exports.UnitOfMeasureTypes = UnitOfMeasureTypes = {}));
88
+ //# sourceMappingURL=unit-of-measure-types.js.map
package/lib/models/customs/unit-of-measure-types.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"unit-of-measure-types.js","sourceRoot":"","sources":["../../../src/models/customs/unit-of-measure-types.ts"],"names":[],"mappings":";;;AAAA,uEAAuE;AACvE,IAAY,kBAiFX;AAjFD,WAAY,kBAAkB;IAC5B,0BAA0B;IAC1B,uCAAiB,CAAA;IACjB,0BAA0B;IAC1B,uCAAiB,CAAA;IACjB,uBAAuB;IACvB,iCAAW,CAAA;IACX,yBAAyB;IACzB,qCAAe,CAAA;IACf,uBAAuB;IACvB,iCAAW,CAAA;IACX,wBAAwB;IACxB,mCAAa,CAAA;IACb,wBAAwB;IACxB,mCAAa,CAAA;IACb,4BAA4B;IAC5B,2CAAqB,CAAA;IACrB,8BAA8B;IAC9B,+CAAyB,CAAA;IACzB,6BAA6B;IAC7B,6CAAuB,CAAA;IACvB,yBAAyB;IACzB,qCAAe,CAAA;IACf,wBAAwB;IACxB,mCAAa,CAAA;IACb,0BAA0B;IAC1B,uCAAiB,CAAA;IACjB,4BAA4B;IAC5B,2CAAqB,CAAA;IACrB,yBAAyB;IACzB,qCAAe,CAAA;IACf,wBAAwB;IACxB,mCAAa,CAAA;IACb,4BAA4B;IAC5B,2CAAqB,CAAA;IACrB,wBAAwB;IACxB,mCAAa,CAAA;IACb,4BAA4B;IAC5B,2CAAqB,CAAA;IACrB,6BAA6B;IAC7B,6CAAuB,CAAA;IACvB,yBAAyB;IACzB,qCAAe,CAAA;IACf,0BAA0B;IAC1B,uCAAiB,CAAA;IACjB,yBAAyB;IACzB,qCAAe,CAAA;IACf,yBAAyB;IACzB,qCAAe,CAAA;IACf,0BAA0B;IAC1B,uCAAiB,CAAA;IACjB,0BAA0B;IAC1B,uCAAiB,CAAA;IACjB,0BAA0B;IAC1B,uCAAiB,CAAA;IACjB,yBAAyB;IACzB,qCAAe,CAAA;IACf,0BAA0B;IAC1B,uCAAiB,CAAA;IACjB,gCAAgC;IAChC,mDAA6B,CAAA;IAC7B,2BAA2B;IAC3B,yCAAmB,CAAA;IACnB,wBAAwB;IACxB,mCAAa,CAAA;IACb,yBAAyB;IACzB,qCAAe,CAAA;IACf,wBAAwB;IACxB,mCAAa,CAAA;IACb,uBAAuB;IACvB,iCAAW,CAAA;IACX,iCAAiC;IACjC,qDAA+B,CAAA;IAC/B,gCAAgC;IAChC,mDAA6B,CAAA;IAC7B,wBAAwB;IACxB,mCAAa,CAAA;IACb,wBAAwB;IACxB,mCAAa,CAAA;IACb,yBAAyB;IACzB,qCAAe,CAAA;AACjB,CAAC,EAjFW,kBAAkB,kCAAlB,kBAAkB,QAiF7B"}
package/lib/models/products.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import { WeightDetails } from './units/weight-details';
2
2
  import { Currency } from './currency';
3
3
  import { DangerousGoods } from './dangerous-good/dangerous-goods';
4
+ import { UnitOfMeasureTypes } from './customs/unit-of-measure-types';
4
5
  /** @description Basic structure for a product */
5
6
  export declare class Products {
6
7
  /** @description A user specified free form string describing this customs item. If the field is absent the user has not specified a description */
@@ -13,6 +14,8 @@ export declare class Products {
13
14
  country_of_origin?: string;
14
15
  /** @description The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information */
15
16
  harmonized_tariff_code?: string;
17
+ /** @description The user specified unit of measure of this customs item */
18
+ unit_of_measure?: UnitOfMeasureTypes;
16
19
  /** @description The user specified SKU of this customs item. This field is completely free form. */
17
20
  sku?: string;
18
21
  /** @description The user specified SKU description of this customs item. This field is completely free form. */
package/lib/models/products.js CHANGED
@@ -13,6 +13,8 @@ class Products {
13
13
  country_of_origin;
14
14
  /** @description The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information */
15
15
  harmonized_tariff_code;
16
+ /** @description The user specified unit of measure of this customs item */
17
+ unit_of_measure;
16
18
  /** @description The user specified SKU of this customs item. This field is completely free form. */
17
19
  sku;
18
20
  /** @description The user specified SKU description of this customs item. This field is completely free form. */
package/lib/models/products.js.map CHANGED
@@ -1 +1 @@
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;CAGpC;AA3BD,4BA2BC"}
1
+ {"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/models/products.ts"],"names":[],"mappings":";;;AAKA,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,2EAA2E;IAC3E,eAAe,CAAsB;IACrC,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;CAGpC;AA7BD,4BA6BC"}
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.10",
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
  }
@@ -3076,6 +3076,51 @@
3076
3076
  ],
3077
3077
  "type": "string"
3078
3078
  },
3079
+ "UnitOfMeasureEnum": {
3080
+ "enum": [
3081
+ "barrel",
3082
+ "bundle",
3083
+ "bag",
3084
+ "bunch",
3085
+ "box",
3086
+ "bolt",
3087
+ "butt",
3088
+ "canister",
3089
+ "centimeter",
3090
+ "container",
3091
+ "crate",
3092
+ "case",
3093
+ "carton",
3094
+ "cylinder",
3095
+ "dozen",
3096
+ "each",
3097
+ "envelope",
3098
+ "feet",
3099
+ "kilogram",
3100
+ "kilograms",
3101
+ "pound",
3102
+ "pounds",
3103
+ "liter",
3104
+ "meter",
3105
+ "number",
3106
+ "packet",
3107
+ "pallet",
3108
+ "piece",
3109
+ "pieces",
3110
+ "proof_liters",
3111
+ "package",
3112
+ "pair",
3113
+ "pairs",
3114
+ "roll",
3115
+ "set",
3116
+ "square_meters",
3117
+ "square_yards",
3118
+ "tube",
3119
+ "yard",
3120
+ "other"
3121
+ ],
3122
+ "type": "string"
3123
+ },
3079
3124
  "PaperlessDetails": {
3080
3125
  "type": "object",
3081
3126
  "properties": {
@@ -3285,6 +3330,9 @@
3285
3330
  "description": "The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information.",
3286
3331
  "nullable": true
3287
3332
  },
3333
+ "unit_of_measure": {
3334
+ "$ref": "#/components/schemas/UnitOfMeasureEnum"
3335
+ },
3288
3336
  "sku": {
3289
3337
  "type": "string",
3290
3338
  "description": "The user specified SKU of this customs item. This field is completely free form.",
@@ -4415,7 +4463,12 @@
4415
4463
  },
4416
4464
  "event_code": {
4417
4465
  "type": "string",
4418
- "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.",
4419
4472
  "nullable": true
4420
4473
  },
4421
4474
  "description": {
@@ -4522,7 +4575,12 @@
4522
4575
  },
4523
4576
  "carrier_status_code": {
4524
4577
  "type": "string",
4525
- "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.",
4526
4584
  "nullable": true
4527
4585
  },
4528
4586
  "carrier_status_description": {
package/src/models/customs/unit-of-measure-types.ts ADDED
@@ -0,0 +1,83 @@
1
+ /** @description This attribute mentions the type of unit of measure */
2
+ export enum UnitOfMeasureTypes {
3
+ /** @description barrel */
4
+ Barrel = 'barrel',
5
+ /** @description bundle */
6
+ Bundle = 'bundle',
7
+ /** @description bag */
8
+ Bag = 'bag',
9
+ /** @description bunch */
10
+ Bunch = 'bunch',
11
+ /** @description box */
12
+ Box = 'box',
13
+ /** @description bolt */
14
+ Bolt = 'bolt',
15
+ /** @description butt */
16
+ Butt = 'butt',
17
+ /** @description canister */
18
+ Canister = 'canister',
19
+ /** @description centimeter */
20
+ Centimeter = 'centimeter',
21
+ /** @description container */
22
+ Container = 'container',
23
+ /** @description crate */
24
+ Crate = 'crate',
25
+ /** @description case */
26
+ Case = 'case',
27
+ /** @description carton */
28
+ Carton = 'carton',
29
+ /** @description cylinder */
30
+ Cylinder = 'cylinder',
31
+ /** @description dozen */
32
+ Dozen = 'dozen',
33
+ /** @description each */
34
+ Each = 'each',
35
+ /** @description envelope */
36
+ Envelope = 'envelope',
37
+ /** @description feet */
38
+ Feet = 'feet',
39
+ /** @description kilogram */
40
+ Kilogram = 'kilogram',
41
+ /** @description kilograms */
42
+ Kilograms = 'kilograms',
43
+ /** @description pound */
44
+ Pound = 'pound',
45
+ /** @description pounds */
46
+ Pounds = 'pounds',
47
+ /** @description liter */
48
+ Liter = 'liter',
49
+ /** @description meter */
50
+ Meter = 'meter',
51
+ /** @description number */
52
+ Number = 'number',
53
+ /** @description packet */
54
+ Packet = 'packet',
55
+ /** @description pallet */
56
+ Pallet = 'pallet',
57
+ /** @description piece */
58
+ Piece = 'piece',
59
+ /** @description pieces */
60
+ Pieces = 'pieces',
61
+ /** @description proof_liters */
62
+ Proof_Liters = 'proof_liters',
63
+ /** @description package */
64
+ Package = 'package',
65
+ /** @description pair */
66
+ Pair = 'pair',
67
+ /** @description pairs */
68
+ Pairs = 'pairs',
69
+ /** @description roll */
70
+ Roll = 'roll',
71
+ /** @description set */
72
+ Set = 'set',
73
+ /** @description square_meters */
74
+ Square_Meters = 'square_meters',
75
+ /** @description square_yards */
76
+ Square_Yards = 'square_yards',
77
+ /** @description tube */
78
+ Tube = 'tube',
79
+ /** @description yard */
80
+ Yard = 'yard',
81
+ /** @description other */
82
+ Other = 'other',
83
+ }
package/src/models/products.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import { WeightDetails } from './units/weight-details';
2
2
  import { Currency } from './currency';
3
3
  import { DangerousGoods } from './dangerous-good/dangerous-goods';
4
+ import { UnitOfMeasureTypes } from './customs/unit-of-measure-types';
4
5
 
5
6
  /** @description Basic structure for a product */
6
7
  export class Products {
@@ -14,6 +15,8 @@ export class Products {
14
15
  country_of_origin?: string;
15
16
  /** @description The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information */
16
17
  harmonized_tariff_code?: string;
18
+ /** @description The user specified unit of measure of this customs item */
19
+ unit_of_measure?: UnitOfMeasureTypes;
17
20
  /** @description The user specified SKU of this customs item. This field is completely free form. */
18
21
  sku?: string;
19
22
  /** @description The user specified SKU description of this customs item. This field is completely free form. */
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. */