@shipengine/connect-carrier-api 4.13.0 → 4.14.1
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.
- package/lib/app/metadata/carrier-attributes.d.ts +2 -1
- package/lib/app/metadata/carrier-attributes.js +1 -0
- package/lib/app/metadata/carrier-attributes.js.map +1 -1
- package/lib/app/metadata/enums.d.ts +2 -1
- package/lib/app/metadata/enums.js +1 -0
- package/lib/app/metadata/enums.js.map +1 -1
- package/lib/models/tracking/proof-of-delivery-format-schema.d.ts +2 -0
- package/lib/models/tracking/proof-of-delivery-format-schema.js +8 -0
- package/lib/models/tracking/proof-of-delivery-format-schema.js.map +1 -0
- package/lib/models/tracking/proof-of-delivery-format.d.ts +4 -0
- package/lib/models/tracking/proof-of-delivery-format.js +9 -0
- package/lib/models/tracking/proof-of-delivery-format.js.map +1 -0
- package/lib/models/tracking/proof-of-delivery-schema.d.ts +2 -0
- package/lib/models/tracking/proof-of-delivery-schema.js +11 -0
- package/lib/models/tracking/proof-of-delivery-schema.js.map +1 -0
- package/lib/models/tracking/proof-of-delivery.d.ts +8 -0
- package/lib/models/tracking/proof-of-delivery.js +12 -0
- package/lib/models/tracking/proof-of-delivery.js.map +1 -0
- package/lib/models/tracking/standardized-status-detail-codes.d.ts +6 -3
- package/lib/models/tracking/standardized-status-detail-codes.js +5 -2
- package/lib/models/tracking/standardized-status-detail-codes.js.map +1 -1
- package/lib/models/tracking/track-event-schema.js +2 -0
- package/lib/models/tracking/track-event-schema.js.map +1 -1
- package/lib/models/tracking/track-event.d.ts +3 -0
- package/lib/models/tracking/track-event.js +2 -0
- package/lib/models/tracking/track-event.js.map +1 -1
- package/package.json +1 -1
- package/spec.json +37 -4
- package/src/app/metadata/carrier-attributes.ts +1 -0
- package/src/app/metadata/enums.ts +1 -0
- package/src/models/tracking/proof-of-delivery-format-schema.ts +6 -0
- package/src/models/tracking/proof-of-delivery-format.ts +4 -0
- package/src/models/tracking/proof-of-delivery-schema.ts +7 -0
- package/src/models/tracking/proof-of-delivery.ts +9 -0
- package/src/models/tracking/standardized-status-detail-codes.ts +5 -2
- package/src/models/tracking/track-event-schema.ts +2 -0
- package/src/models/tracking/track-event.ts +3 -0
- package/tsconfig.tsbuildinfo +1 -1
|
@@ -5,6 +5,7 @@ export declare enum CarrierAttributeEnum {
|
|
|
5
5
|
Consolidator = "Consolidator",
|
|
6
6
|
Regional = "Regional",
|
|
7
7
|
RequiresInboundWebhook = "RequiresInboundWebhook",
|
|
8
|
-
DetailedStatuses = "DetailedStatuses"
|
|
8
|
+
DetailedStatuses = "DetailedStatuses",
|
|
9
|
+
ProofOfDelivery = "ProofOfDelivery"
|
|
9
10
|
}
|
|
10
11
|
export declare const CarrierAttributeEnumSchema: Joi.StringSchema;
|
|
@@ -11,6 +11,7 @@ var CarrierAttributeEnum;
|
|
|
11
11
|
CarrierAttributeEnum["Regional"] = "Regional";
|
|
12
12
|
CarrierAttributeEnum["RequiresInboundWebhook"] = "RequiresInboundWebhook";
|
|
13
13
|
CarrierAttributeEnum["DetailedStatuses"] = "DetailedStatuses";
|
|
14
|
+
CarrierAttributeEnum["ProofOfDelivery"] = "ProofOfDelivery";
|
|
14
15
|
})(CarrierAttributeEnum || (exports.CarrierAttributeEnum = CarrierAttributeEnum = {}));
|
|
15
16
|
exports.CarrierAttributeEnumSchema = joi_1.default.string().valid(...Object.values(CarrierAttributeEnum));
|
|
16
17
|
//# sourceMappingURL=carrier-attributes.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"carrier-attributes.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier-attributes.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,IAAY,
|
|
1
|
+
{"version":3,"file":"carrier-attributes.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier-attributes.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,IAAY,oBAQX;AARD,WAAY,oBAAoB;IAC9B,2DAAmC,CAAA;IACnC,6DAAqC,CAAA;IACrC,qDAA6B,CAAA;IAC7B,6CAAqB,CAAA;IACrB,yEAAiD,CAAA;IACjD,6DAAqC,CAAA;IACrC,2DAAmC,CAAA;AACrC,CAAC,EARW,oBAAoB,oCAApB,oBAAoB,QAQ/B;AAEY,QAAA,0BAA0B,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAC1D,GAAG,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CACvC,CAAC"}
|
|
@@ -4,7 +4,8 @@ export declare enum CarrierAttribute {
|
|
|
4
4
|
Consolidator = "Consolidator",
|
|
5
5
|
Regional = "Regional",
|
|
6
6
|
RequiresInboundWebhook = "RequiresInboundWebhook",
|
|
7
|
-
DetailedStatuses = "DetailedStatuses"
|
|
7
|
+
DetailedStatuses = "DetailedStatuses",
|
|
8
|
+
ProofOfDelivery = "ProofOfDelivery"
|
|
8
9
|
}
|
|
9
10
|
export declare enum ShippingServiceAttribute {
|
|
10
11
|
Returns = "Returns",
|
|
@@ -9,6 +9,7 @@ var CarrierAttribute;
|
|
|
9
9
|
CarrierAttribute["Regional"] = "Regional";
|
|
10
10
|
CarrierAttribute["RequiresInboundWebhook"] = "RequiresInboundWebhook";
|
|
11
11
|
CarrierAttribute["DetailedStatuses"] = "DetailedStatuses";
|
|
12
|
+
CarrierAttribute["ProofOfDelivery"] = "ProofOfDelivery";
|
|
12
13
|
})(CarrierAttribute || (exports.CarrierAttribute = CarrierAttribute = {}));
|
|
13
14
|
var ShippingServiceAttribute;
|
|
14
15
|
(function (ShippingServiceAttribute) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/app/metadata/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,
|
|
1
|
+
{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/app/metadata/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,gBAQX;AARD,WAAY,gBAAgB;IAC1B,uDAAmC,CAAA;IACnC,yDAAqC,CAAA;IACrC,iDAA6B,CAAA;IAC7B,yCAAqB,CAAA;IACrB,qEAAiD,CAAA;IACjD,yDAAqC,CAAA;IACrC,uDAAmC,CAAA;AACrC,CAAC,EARW,gBAAgB,gCAAhB,gBAAgB,QAQ3B;AAED,IAAY,wBAcX;AAdD,WAAY,wBAAwB;IAClC,+CAAmB,CAAA;IACnB,yDAA6B,CAAA;IAC7B,iDAAqB,CAAA;IACrB,uEAA2C,CAAA;IAC3C,iFAAqD,CAAA;IACrD,+DAAmC,CAAA;IACnC,iEAAqC,CAAA;IACrC,6DAAiC,CAAA;IACjC,uCAAW,CAAA;IACX,6DAAiC,CAAA;IACjC,2EAA+C,CAAA;IAC/C,6DAAiC,CAAA;IACjC,6EAAiD,CAAA;AACnD,CAAC,EAdW,wBAAwB,wCAAxB,wBAAwB,QAcnC;AAED,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,6CAAuB,CAAA;AACzB,CAAC,EAHW,kBAAkB,kCAAlB,kBAAkB,QAG7B;AAED,IAAY,YASX;AATD,WAAY,YAAY;IACtB,2CAA2B,CAAA;IAC3B,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,2CAA2B,CAAA;IAC3B,+CAA+B,CAAA;IAC/B,iCAAiB,CAAA;IACjB,2CAA2B,CAAA;IAC3B,qCAAqB,CAAA;AACvB,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AAED,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,2CAA2B,CAAA;IAC3B,mCAAmB,CAAA;IACnB,uCAAuB,CAAA;IACvB,uCAAuB,CAAA;IACvB,qCAAqB,CAAA;AACvB,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AAED,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,6CAAyB,CAAA;AAC3B,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ProofOfDeliveryFormatSchema = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const joi_1 = tslib_1.__importDefault(require("joi"));
|
|
6
|
+
const proof_of_delivery_format_1 = require("./proof-of-delivery-format");
|
|
7
|
+
exports.ProofOfDeliveryFormatSchema = joi_1.default.string().valid(...Object.values(proof_of_delivery_format_1.ProofOfDeliveryFormat));
|
|
8
|
+
//# sourceMappingURL=proof-of-delivery-format-schema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"proof-of-delivery-format-schema.js","sourceRoot":"","sources":["../../../src/models/tracking/proof-of-delivery-format-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,yEAAmE;AAEtD,QAAA,2BAA2B,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAC3D,GAAG,MAAM,CAAC,MAAM,CAAC,gDAAqB,CAAC,CACxC,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ProofOfDeliveryFormat = void 0;
|
|
4
|
+
var ProofOfDeliveryFormat;
|
|
5
|
+
(function (ProofOfDeliveryFormat) {
|
|
6
|
+
ProofOfDeliveryFormat["Pdf"] = "PDF";
|
|
7
|
+
ProofOfDeliveryFormat["Png"] = "PNG";
|
|
8
|
+
})(ProofOfDeliveryFormat || (exports.ProofOfDeliveryFormat = ProofOfDeliveryFormat = {}));
|
|
9
|
+
//# sourceMappingURL=proof-of-delivery-format.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"proof-of-delivery-format.js","sourceRoot":"","sources":["../../../src/models/tracking/proof-of-delivery-format.ts"],"names":[],"mappings":";;;AAAA,IAAY,qBAGX;AAHD,WAAY,qBAAqB;IAC/B,oCAAW,CAAA;IACX,oCAAW,CAAA;AACb,CAAC,EAHW,qBAAqB,qCAArB,qBAAqB,QAGhC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ProofOfDeliverySchema = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const joi_1 = tslib_1.__importDefault(require("joi"));
|
|
6
|
+
const proof_of_delivery_format_schema_1 = require("./proof-of-delivery-format-schema");
|
|
7
|
+
exports.ProofOfDeliverySchema = joi_1.default.object({
|
|
8
|
+
data: joi_1.default.string().required(),
|
|
9
|
+
format: proof_of_delivery_format_schema_1.ProofOfDeliveryFormatSchema.required(),
|
|
10
|
+
});
|
|
11
|
+
//# sourceMappingURL=proof-of-delivery-schema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"proof-of-delivery-schema.js","sourceRoot":"","sources":["../../../src/models/tracking/proof-of-delivery-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,uFAAgF;AAEnE,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,6DAA2B,CAAC,QAAQ,EAAE;CAC/C,CAAC,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { ProofOfDeliveryFormat } from './proof-of-delivery-format';
|
|
2
|
+
/** @description An image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc. */
|
|
3
|
+
export declare class ProofOfDelivery {
|
|
4
|
+
/** @description Base64 encoded data for the proof of delivery. */
|
|
5
|
+
data: string;
|
|
6
|
+
/** @description The format the document is in.\r\nPdf - PDF\r\nPng - PNG */
|
|
7
|
+
format: ProofOfDeliveryFormat;
|
|
8
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ProofOfDelivery = void 0;
|
|
4
|
+
/** @description An image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc. */
|
|
5
|
+
class ProofOfDelivery {
|
|
6
|
+
/** @description Base64 encoded data for the proof of delivery. */
|
|
7
|
+
data;
|
|
8
|
+
/** @description The format the document is in.\r\nPdf - PDF\r\nPng - PNG */
|
|
9
|
+
format;
|
|
10
|
+
}
|
|
11
|
+
exports.ProofOfDelivery = ProofOfDelivery;
|
|
12
|
+
//# sourceMappingURL=proof-of-delivery.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"proof-of-delivery.js","sourceRoot":"","sources":["../../../src/models/tracking/proof-of-delivery.ts"],"names":[],"mappings":";;;AAEA,iRAAiR;AACjR,MAAa,eAAe;IAC1B,kEAAkE;IAClE,IAAI,CAAU;IACd,4EAA4E;IAC5E,MAAM,CAAyB;CAChC;AALD,0CAKC"}
|
|
@@ -51,8 +51,6 @@ export declare enum StandardizedStatusDetailCodes {
|
|
|
51
51
|
HeldByCarrier = "HELD_BY_CARRIER",
|
|
52
52
|
HeldByCarrierForClearancePreProcessing = "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING",
|
|
53
53
|
HeldByCustoms = "HELD_BY_CUSTOMS",
|
|
54
|
-
HeldByExportCustoms = "HELD_BY_EXPORT_CUSTOMS",
|
|
55
|
-
HeldByImportCustoms = "HELD_BY_IMPORT_CUSTOMS",
|
|
56
54
|
IncorrectDeclaration = "INCORRECT_DECLARATION",
|
|
57
55
|
Misrouted = "MISROUTED",
|
|
58
56
|
ParcelRepacked = "PARCEL_REPACKED",
|
|
@@ -71,5 +69,10 @@ export declare enum StandardizedStatusDetailCodes {
|
|
|
71
69
|
ParcelOutsideOfServiceCapability = "PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY",
|
|
72
70
|
RefusedByCustomer = "REFUSED_BY_CUSTOMER",
|
|
73
71
|
ReturnToSender = "RETURN_TO_SENDER",
|
|
74
|
-
UnspecifiedException = "UNSPECIFIED_EXCEPTION"
|
|
72
|
+
UnspecifiedException = "UNSPECIFIED_EXCEPTION",
|
|
73
|
+
TrackingExpired = "TRACKING_EXPIRED",
|
|
74
|
+
DutyNotPaid = "DUTY_NOT_PAID",
|
|
75
|
+
ParcelRedirectedByCarrier = "PARCEL_REDIRECTED_BY_CARRIER",
|
|
76
|
+
DeliveredToPickupPoint = "DELIVERED_TO_PICKUP_POINT",
|
|
77
|
+
UndeliverableReturnedToSender = "UNDELIVERABLE_RETURNED_TO_SENDER"
|
|
75
78
|
}
|
|
@@ -55,8 +55,6 @@ var StandardizedStatusDetailCodes;
|
|
|
55
55
|
StandardizedStatusDetailCodes["HeldByCarrier"] = "HELD_BY_CARRIER";
|
|
56
56
|
StandardizedStatusDetailCodes["HeldByCarrierForClearancePreProcessing"] = "HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING";
|
|
57
57
|
StandardizedStatusDetailCodes["HeldByCustoms"] = "HELD_BY_CUSTOMS";
|
|
58
|
-
StandardizedStatusDetailCodes["HeldByExportCustoms"] = "HELD_BY_EXPORT_CUSTOMS";
|
|
59
|
-
StandardizedStatusDetailCodes["HeldByImportCustoms"] = "HELD_BY_IMPORT_CUSTOMS";
|
|
60
58
|
StandardizedStatusDetailCodes["IncorrectDeclaration"] = "INCORRECT_DECLARATION";
|
|
61
59
|
StandardizedStatusDetailCodes["Misrouted"] = "MISROUTED";
|
|
62
60
|
StandardizedStatusDetailCodes["ParcelRepacked"] = "PARCEL_REPACKED";
|
|
@@ -76,5 +74,10 @@ var StandardizedStatusDetailCodes;
|
|
|
76
74
|
StandardizedStatusDetailCodes["RefusedByCustomer"] = "REFUSED_BY_CUSTOMER";
|
|
77
75
|
StandardizedStatusDetailCodes["ReturnToSender"] = "RETURN_TO_SENDER";
|
|
78
76
|
StandardizedStatusDetailCodes["UnspecifiedException"] = "UNSPECIFIED_EXCEPTION";
|
|
77
|
+
StandardizedStatusDetailCodes["TrackingExpired"] = "TRACKING_EXPIRED";
|
|
78
|
+
StandardizedStatusDetailCodes["DutyNotPaid"] = "DUTY_NOT_PAID";
|
|
79
|
+
StandardizedStatusDetailCodes["ParcelRedirectedByCarrier"] = "PARCEL_REDIRECTED_BY_CARRIER";
|
|
80
|
+
StandardizedStatusDetailCodes["DeliveredToPickupPoint"] = "DELIVERED_TO_PICKUP_POINT";
|
|
81
|
+
StandardizedStatusDetailCodes["UndeliverableReturnedToSender"] = "UNDELIVERABLE_RETURNED_TO_SENDER";
|
|
79
82
|
})(StandardizedStatusDetailCodes || (exports.StandardizedStatusDetailCodes = StandardizedStatusDetailCodes = {}));
|
|
80
83
|
//# sourceMappingURL=standardized-status-detail-codes.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"standardized-status-detail-codes.js","sourceRoot":"","sources":["../../../src/models/tracking/standardized-status-detail-codes.ts"],"names":[],"mappings":";;;AAAA,yFAAyF;AACzF,IAAY,
|
|
1
|
+
{"version":3,"file":"standardized-status-detail-codes.js","sourceRoot":"","sources":["../../../src/models/tracking/standardized-status-detail-codes.ts"],"names":[],"mappings":";;;AAAA,yFAAyF;AACzF,IAAY,6BA4EX;AA5ED,WAAY,6BAA6B;IACvC,qFAAoD,CAAA;IACpD,qEAAoC,CAAA;IACpC,mFAAkD,CAAA;IAClD,2DAA0B,CAAA;IAC1B,wFAAuD,CAAA;IACvD,uDAAsB,CAAA;IACtB,mEAAkC,CAAA;IAClC,yEAAwC,CAAA;IACxC,mGAAkE,CAAA;IAClE,4DAA2B,CAAA;IAC3B,0DAAyB,CAAA;IACzB,yDAAwB,CAAA;IACxB,4DAA2B,CAAA;IAC3B,4EAA2C,CAAA;IAC3C,wFAAuD,CAAA;IACvD,0EAAyC,CAAA;IACzC,6FAA4D,CAAA;IAC5D,4EAA2C,CAAA;IAC3C,kFAAiD,CAAA;IACjD,uEAAsC,CAAA;IACtC,yEAAwC,CAAA;IACxC,iEAAgC,CAAA;IAChC,6EAA4C,CAAA;IAC5C,yEAAwC,CAAA;IACxC,oFAAmD,CAAA;IACnD,kEAAiC,CAAA;IACjC,mEAAkC,CAAA;IAClC,oEAAmC,CAAA;IACnC,4GAA2E,CAAA;IAC3E,yEAAwC,CAAA;IACxC,kGAAiE,CAAA;IACjE,gFAA+C,CAAA;IAC/C,wDAAuB,CAAA;IACvB,uEAAsC,CAAA;IACtC,sEAAqC,CAAA;IACrC,+FAA8D,CAAA;IAC9D,sHAAqF,CAAA;IACrF,gFAA+C,CAAA;IAC/C,yEAAwC,CAAA;IACxC,sGAAqE,CAAA;IACrE,0EAAyC,CAAA;IACzC,sEAAqC,CAAA;IACrC,+DAA8B,CAAA;IAC9B,wFAAuD,CAAA;IACvD,iEAAgC,CAAA;IAChC,+DAA8B,CAAA;IAC9B,iEAAgC,CAAA;IAChC,0EAAyC,CAAA;IACzC,kEAAiC,CAAA;IACjC,wHAAuF,CAAA;IACvF,kEAAiC,CAAA;IACjC,+EAA8C,CAAA;IAC9C,wDAAuB,CAAA;IACvB,mEAAkC,CAAA;IAClC,6FAA4D,CAAA;IAC5D,yEAAwC,CAAA;IACxC,gGAA+D,CAAA;IAC/D,gGAA+D,CAAA;IAC/D,wDAAuB,CAAA;IACvB,iEAAgC,CAAA;IAChC,6EAA4C,CAAA;IAC5C,gGAA+D,CAAA;IAC/D,+DAA8B,CAAA;IAC9B,mGAAkE,CAAA;IAClE,mEAAkC,CAAA;IAClC,2DAA0B,CAAA;IAC1B,0GAAyE,CAAA;IACzE,0EAAyC,CAAA;IACzC,oEAAmC,CAAA;IACnC,+EAA8C,CAAA;IAC9C,qEAAoC,CAAA;IACpC,8DAA6B,CAAA;IAC7B,2FAA0D,CAAA;IAC1D,qFAAoD,CAAA;IACpD,mGAAkE,CAAA;AACpE,CAAC,EA5EW,6BAA6B,6CAA7B,6BAA6B,QA4ExC"}
|
|
@@ -6,11 +6,13 @@ const joi_1 = tslib_1.__importDefault(require("joi"));
|
|
|
6
6
|
const lat_long_schema_1 = require("./lat-long-schema");
|
|
7
7
|
const standardized_status_codes_schema_1 = require("./standardized-status-codes-schema");
|
|
8
8
|
const standardized_status_detail_codes_schema_1 = require("./standardized-status-detail-codes-schema");
|
|
9
|
+
const proof_of_delivery_schema_1 = require("./proof-of-delivery-schema");
|
|
9
10
|
exports.TrackEventSchema = joi_1.default.object({
|
|
10
11
|
event_datetime: joi_1.default.string().optional().empty().isoDate(),
|
|
11
12
|
event_datetime_local: joi_1.default.string().optional().empty().isoDate(),
|
|
12
13
|
event_code: joi_1.default.string().optional().empty(),
|
|
13
14
|
carrier_detail_code: joi_1.default.string().optional().empty(),
|
|
15
|
+
proof_of_delivery: proof_of_delivery_schema_1.ProofOfDeliverySchema.optional(),
|
|
14
16
|
description: joi_1.default.string().optional().empty(),
|
|
15
17
|
city: joi_1.default.string().optional().empty(),
|
|
16
18
|
state: joi_1.default.string().optional().empty(),
|
|
@@ -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;
|
|
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;AAChG,yEAAmE;AAEtD,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,iBAAiB,EAAE,gDAAqB,CAAC,QAAQ,EAAE;IACnD,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,6 +1,7 @@
|
|
|
1
1
|
import { LatLong } from './lat-long';
|
|
2
2
|
import { StandardizedStatusCodes } from './standardized-status-codes';
|
|
3
3
|
import { StandardizedStatusDetailCodes } from './standardized-status-detail-codes';
|
|
4
|
+
import { ProofOfDelivery } from './proof-of-delivery';
|
|
4
5
|
/** @description Basic structure for tracking events */
|
|
5
6
|
export declare class TrackEvent {
|
|
6
7
|
/** @description When this tracking event occurred. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
|
|
@@ -11,6 +12,8 @@ export declare class TrackEvent {
|
|
|
11
12
|
event_code?: string;
|
|
12
13
|
/** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
|
|
13
14
|
carrier_detail_code?: string;
|
|
15
|
+
/** @description An image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc. */
|
|
16
|
+
proof_of_delivery?: ProofOfDelivery;
|
|
14
17
|
/** @description Description of the package status at this event */
|
|
15
18
|
description?: string;
|
|
16
19
|
/** @description City or Locality for this event */
|
|
@@ -11,6 +11,8 @@ class TrackEvent {
|
|
|
11
11
|
event_code;
|
|
12
12
|
/** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
|
|
13
13
|
carrier_detail_code;
|
|
14
|
+
/** @description An image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc. */
|
|
15
|
+
proof_of_delivery;
|
|
14
16
|
/** @description Description of the package status at this event */
|
|
15
17
|
description;
|
|
16
18
|
/** @description City or Locality for this event */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"track-event.js","sourceRoot":"","sources":["../../../src/models/tracking/track-event.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"track-event.js","sourceRoot":"","sources":["../../../src/models/tracking/track-event.ts"],"names":[],"mappings":";;;AAKA,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,iRAAiR;IACjR,iBAAiB,CAAmB;IACpC,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;AA/BD,gCA+BC"}
|
package/package.json
CHANGED
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.
|
|
6
|
+
"version": "1.27.0"
|
|
7
7
|
},
|
|
8
8
|
"paths": {
|
|
9
9
|
"/Register": {
|
|
@@ -4331,8 +4331,6 @@
|
|
|
4331
4331
|
"HELD_BY_CARRIER",
|
|
4332
4332
|
"HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING",
|
|
4333
4333
|
"HELD_BY_CUSTOMS",
|
|
4334
|
-
"HELD_BY_EXPORT_CUSTOMS",
|
|
4335
|
-
"HELD_BY_IMPORT_CUSTOMS",
|
|
4336
4334
|
"INCORRECT_DECLARATION",
|
|
4337
4335
|
"MISROUTED",
|
|
4338
4336
|
"PARCEL_REPACKED",
|
|
@@ -4351,11 +4349,43 @@
|
|
|
4351
4349
|
"PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY",
|
|
4352
4350
|
"REFUSED_BY_CUSTOMER",
|
|
4353
4351
|
"RETURN_TO_SENDER",
|
|
4354
|
-
"UNSPECIFIED_EXCEPTION"
|
|
4352
|
+
"UNSPECIFIED_EXCEPTION",
|
|
4353
|
+
"TRACKING_EXPIRED",
|
|
4354
|
+
"DUTY_NOT_PAID",
|
|
4355
|
+
"PARCEL_REDIRECTED_BY_CARRIER",
|
|
4356
|
+
"DELIVERED_TO_PICKUP_POINT",
|
|
4357
|
+
"UNDELIVERABLE_RETURNED_TO_SENDER"
|
|
4355
4358
|
],
|
|
4356
4359
|
"type": "string",
|
|
4357
4360
|
"description": "This represents the ShipEngine supported detail codes for a shipment."
|
|
4358
4361
|
},
|
|
4362
|
+
"ProofOfDelivery": {
|
|
4363
|
+
"required": [
|
|
4364
|
+
"data",
|
|
4365
|
+
"format"
|
|
4366
|
+
],
|
|
4367
|
+
"type": "object",
|
|
4368
|
+
"properties": {
|
|
4369
|
+
"data": {
|
|
4370
|
+
"type": "string",
|
|
4371
|
+
"description": "Base64 encoded data for the proof of delivery.",
|
|
4372
|
+
"nullable": true
|
|
4373
|
+
},
|
|
4374
|
+
"format": {
|
|
4375
|
+
"$ref": "#/components/schemas/ProofOfDeliveryFormat"
|
|
4376
|
+
}
|
|
4377
|
+
},
|
|
4378
|
+
"additionalProperties": false,
|
|
4379
|
+
"description": "An image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc."
|
|
4380
|
+
},
|
|
4381
|
+
"ProofOfDeliveryFormat": {
|
|
4382
|
+
"enum": [
|
|
4383
|
+
"PDF",
|
|
4384
|
+
"PNG"
|
|
4385
|
+
],
|
|
4386
|
+
"type": "string",
|
|
4387
|
+
"description": "The format the document is in.\r\nPdf - PDF\r\nPng - PNG"
|
|
4388
|
+
},
|
|
4359
4389
|
"TaxDetails": {
|
|
4360
4390
|
"type": "object",
|
|
4361
4391
|
"properties": {
|
|
@@ -4542,6 +4572,9 @@
|
|
|
4542
4572
|
},
|
|
4543
4573
|
"status_detail_code": {
|
|
4544
4574
|
"$ref": "#/components/schemas/StandardizedStatusDetailCodes"
|
|
4575
|
+
},
|
|
4576
|
+
"proof_of_delivery": {
|
|
4577
|
+
"$ref": "#/components/schemas/ProofOfDelivery"
|
|
4545
4578
|
}
|
|
4546
4579
|
},
|
|
4547
4580
|
"additionalProperties": false,
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { ProofOfDeliveryFormat } from './proof-of-delivery-format';
|
|
2
|
+
|
|
3
|
+
/** @description An image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc. */
|
|
4
|
+
export class ProofOfDelivery {
|
|
5
|
+
/** @description Base64 encoded data for the proof of delivery. */
|
|
6
|
+
data!: string;
|
|
7
|
+
/** @description The format the document is in.\r\nPdf - PDF\r\nPng - PNG */
|
|
8
|
+
format!: ProofOfDeliveryFormat;
|
|
9
|
+
}
|
|
@@ -51,8 +51,6 @@ export enum StandardizedStatusDetailCodes {
|
|
|
51
51
|
HeldByCarrier = 'HELD_BY_CARRIER',
|
|
52
52
|
HeldByCarrierForClearancePreProcessing = 'HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING',
|
|
53
53
|
HeldByCustoms = 'HELD_BY_CUSTOMS',
|
|
54
|
-
HeldByExportCustoms = 'HELD_BY_EXPORT_CUSTOMS',
|
|
55
|
-
HeldByImportCustoms = 'HELD_BY_IMPORT_CUSTOMS',
|
|
56
54
|
IncorrectDeclaration = 'INCORRECT_DECLARATION',
|
|
57
55
|
Misrouted = 'MISROUTED',
|
|
58
56
|
ParcelRepacked = 'PARCEL_REPACKED',
|
|
@@ -72,4 +70,9 @@ export enum StandardizedStatusDetailCodes {
|
|
|
72
70
|
RefusedByCustomer = 'REFUSED_BY_CUSTOMER',
|
|
73
71
|
ReturnToSender = 'RETURN_TO_SENDER',
|
|
74
72
|
UnspecifiedException = 'UNSPECIFIED_EXCEPTION',
|
|
73
|
+
TrackingExpired = 'TRACKING_EXPIRED',
|
|
74
|
+
DutyNotPaid = 'DUTY_NOT_PAID',
|
|
75
|
+
ParcelRedirectedByCarrier = 'PARCEL_REDIRECTED_BY_CARRIER',
|
|
76
|
+
DeliveredToPickupPoint = 'DELIVERED_TO_PICKUP_POINT',
|
|
77
|
+
UndeliverableReturnedToSender = 'UNDELIVERABLE_RETURNED_TO_SENDER',
|
|
75
78
|
}
|
|
@@ -2,12 +2,14 @@ import Joi from 'joi';
|
|
|
2
2
|
import { LatLongSchema } from './lat-long-schema';
|
|
3
3
|
import { StandardizedStatusCodesSchema } from './standardized-status-codes-schema';
|
|
4
4
|
import { StandardizedStatusDetailCodesSchema } from './standardized-status-detail-codes-schema';
|
|
5
|
+
import { ProofOfDeliverySchema } from './proof-of-delivery-schema';
|
|
5
6
|
|
|
6
7
|
export const TrackEventSchema = Joi.object({
|
|
7
8
|
event_datetime: Joi.string().optional().empty().isoDate(),
|
|
8
9
|
event_datetime_local: Joi.string().optional().empty().isoDate(),
|
|
9
10
|
event_code: Joi.string().optional().empty(),
|
|
10
11
|
carrier_detail_code: Joi.string().optional().empty(),
|
|
12
|
+
proof_of_delivery: ProofOfDeliverySchema.optional(),
|
|
11
13
|
description: Joi.string().optional().empty(),
|
|
12
14
|
city: Joi.string().optional().empty(),
|
|
13
15
|
state: Joi.string().optional().empty(),
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { LatLong } from './lat-long';
|
|
2
2
|
import { StandardizedStatusCodes } from './standardized-status-codes';
|
|
3
3
|
import { StandardizedStatusDetailCodes } from './standardized-status-detail-codes';
|
|
4
|
+
import { ProofOfDelivery } from './proof-of-delivery';
|
|
4
5
|
|
|
5
6
|
/** @description Basic structure for tracking events */
|
|
6
7
|
export class TrackEvent {
|
|
@@ -12,6 +13,8 @@ export class TrackEvent {
|
|
|
12
13
|
event_code?: string;
|
|
13
14
|
/** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
|
|
14
15
|
carrier_detail_code?: string;
|
|
16
|
+
/** @description An image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc. */
|
|
17
|
+
proof_of_delivery?: ProofOfDelivery;
|
|
15
18
|
/** @description Description of the package status at this event */
|
|
16
19
|
description?: string;
|
|
17
20
|
/** @description City or Locality for this event */
|