@shipengine/connect-carrier-api 4.12.2 → 4.14.0

package/lib/app/metadata/carrier-attributes.d.ts

@@ -5,6 +5,7 @@ export declare enum CarrierAttributeEnum {
     Consolidator = "Consolidator",
     Regional = "Regional",
     RequiresInboundWebhook = "RequiresInboundWebhook",
-    DetailedStatuses = "DetailedStatuses"
+    DetailedStatuses = "DetailedStatuses",
+    ProofOfDelivery = "ProofOfDelivery"
 }
 export declare const CarrierAttributeEnumSchema: Joi.StringSchema;

package/lib/app/metadata/carrier-attributes.js

@@ -11,6 +11,7 @@ var CarrierAttributeEnum;
     CarrierAttributeEnum["Regional"] = "Regional";
     CarrierAttributeEnum["RequiresInboundWebhook"] = "RequiresInboundWebhook";
     CarrierAttributeEnum["DetailedStatuses"] = "DetailedStatuses";
+    CarrierAttributeEnum["ProofOfDelivery"] = "ProofOfDelivery";
 })(CarrierAttributeEnum || (exports.CarrierAttributeEnum = CarrierAttributeEnum = {}));
 exports.CarrierAttributeEnumSchema = joi_1.default.string().valid(...Object.values(CarrierAttributeEnum));
 //# sourceMappingURL=carrier-attributes.js.map

package/lib/app/metadata/carrier-attributes.js.map

@@ -1 +1 @@
-{"version":3,"file":"carrier-attributes.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier-attributes.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC9B,2DAAmC,CAAA;IACnC,6DAAqC,CAAA;IACrC,qDAA6B,CAAA;IAC7B,6CAAqB,CAAA;IACrB,yEAAiD,CAAA;IACjD,6DAAqC,CAAA;AACvC,CAAC,EAPW,oBAAoB,oCAApB,oBAAoB,QAO/B;AAEY,QAAA,0BAA0B,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAC1D,GAAG,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CACvC,CAAC"}
+{"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"}

package/lib/app/metadata/enums.d.ts

@@ -4,7 +4,8 @@ export declare enum CarrierAttribute {
     Consolidator = "Consolidator",
     Regional = "Regional",
     RequiresInboundWebhook = "RequiresInboundWebhook",
-    DetailedStatuses = "DetailedStatuses"
+    DetailedStatuses = "DetailedStatuses",
+    ProofOfDelivery = "ProofOfDelivery"
 }
 export declare enum ShippingServiceAttribute {
     Returns = "Returns",

package/lib/app/metadata/enums.js

@@ -9,6 +9,7 @@ var CarrierAttribute;
     CarrierAttribute["Regional"] = "Regional";
     CarrierAttribute["RequiresInboundWebhook"] = "RequiresInboundWebhook";
     CarrierAttribute["DetailedStatuses"] = "DetailedStatuses";
+    CarrierAttribute["ProofOfDelivery"] = "ProofOfDelivery";
 })(CarrierAttribute || (exports.CarrierAttribute = CarrierAttribute = {}));
 var ShippingServiceAttribute;
 (function (ShippingServiceAttribute) {

package/lib/app/metadata/enums.js.map

@@ -1 +1 @@
-{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/app/metadata/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,uDAAmC,CAAA;IACnC,yDAAqC,CAAA;IACrC,iDAA6B,CAAA;IAC7B,yCAAqB,CAAA;IACrB,qEAAiD,CAAA;IACjD,yDAAqC,CAAA;AACvC,CAAC,EAPW,gBAAgB,gCAAhB,gBAAgB,QAO3B;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"}
+{"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"}

package/lib/models/billing/billing-line-item.d.ts

@@ -1,5 +1,6 @@
 import { BillingCategories } from './billing-categories';
 import { Currency } from '../currency';
+import { TaxDetails } from './tax-details';
 /** @description Basic structure of each charge or line item */
 export declare class BillingLineItem {
     /** A generalized category for what type of billing line item this is */
@@ -14,4 +15,6 @@ export declare class BillingLineItem {
     amount: Currency;
     /** @description Total amount of the line item billed by the provider. This should only be populated if it differs from 'amount' **/
     provider_billed_amount?: Currency;
+    /** @description Optional field. This field is applicable only to items that represent tax charge. It contains details about the tax, e.g. type (VAT), etc. */
+    tax_details?: TaxDetails;
 }

package/lib/models/billing/billing-line-item.js

@@ -15,6 +15,8 @@ class BillingLineItem {
     amount;
     /** @description Total amount of the line item billed by the provider. This should only be populated if it differs from 'amount' **/
     provider_billed_amount;
+    /** @description Optional field. This field is applicable only to items that represent tax charge. It contains details about the tax, e.g. type (VAT), etc. */
+    tax_details;
 }
 exports.BillingLineItem = BillingLineItem;
 //# sourceMappingURL=billing-line-item.js.map

package/lib/models/billing/billing-line-item.js.map

@@ -1 +1 @@
-{"version":3,"file":"billing-line-item.js","sourceRoot":"","sources":["../../../src/models/billing/billing-line-item.ts"],"names":[],"mappings":";;;AAGA,+DAA+D;AAC/D,MAAa,eAAe;IAC1B,wEAAwE;IACxE,gBAAgB,CAAqB;IACrC,+JAA+J;IAC/J,mBAAmB,CAAU;IAC7B,8DAA8D;IAC9D,oBAAoB,CAAU;IAC9B,6MAA6M;IAC7M,IAAI,CAAU;IACd,oFAAoF;IACpF,MAAM,CAAY;IAClB,oIAAoI;IACpI,sBAAsB,CAAY;CACnC;AAbD,0CAaC"}
+{"version":3,"file":"billing-line-item.js","sourceRoot":"","sources":["../../../src/models/billing/billing-line-item.ts"],"names":[],"mappings":";;;AAIA,+DAA+D;AAC/D,MAAa,eAAe;IAC1B,wEAAwE;IACxE,gBAAgB,CAAqB;IACrC,+JAA+J;IAC/J,mBAAmB,CAAU;IAC7B,8DAA8D;IAC9D,oBAAoB,CAAU;IAC9B,6MAA6M;IAC7M,IAAI,CAAU;IACd,oFAAoF;IACpF,MAAM,CAAY;IAClB,oIAAoI;IACpI,sBAAsB,CAAY;IAClC,8JAA8J;IAC9J,WAAW,CAAc;CAC1B;AAfD,0CAeC"}

package/lib/models/billing/index.d.ts

@@ -3,3 +3,4 @@ export * from './billing-categories-schema';
 export * from './billing-line-item';
 export * from './billing-line-item-schema';
 export * from './billing-to-party';
+export * from './tax-details';

package/lib/models/billing/index.js

@@ -6,4 +6,5 @@ tslib_1.__exportStar(require("./billing-categories-schema"), exports);
 tslib_1.__exportStar(require("./billing-line-item"), exports);
 tslib_1.__exportStar(require("./billing-line-item-schema"), exports);
 tslib_1.__exportStar(require("./billing-to-party"), exports);
+tslib_1.__exportStar(require("./tax-details"), exports);
 //# sourceMappingURL=index.js.map

package/lib/models/billing/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/billing/index.ts"],"names":[],"mappings":";;;AAAA,+DAAqC;AACrC,sEAA4C;AAC5C,8DAAoC;AACpC,qEAA2C;AAC3C,6DAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/billing/index.ts"],"names":[],"mappings":";;;AAAA,+DAAqC;AACrC,sEAA4C;AAC5C,8DAAoC;AACpC,qEAA2C;AAC3C,6DAAmC;AACnC,wDAA8B"}

package/lib/models/billing/tax-details.d.ts

@@ -0,0 +1,7 @@
+import { TaxType } from '../taxes';
+export declare class TaxDetails {
+    tax_type?: TaxType;
+    tax_code?: string;
+    /** @description Tax percentage, e.g. 20, 23.7 */
+    tax_percentage?: number;
+}

package/lib/models/billing/tax-details.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaxDetails = void 0;
+class TaxDetails {
+    tax_type;
+    tax_code;
+    /** @description Tax percentage, e.g. 20, 23.7 */
+    tax_percentage;
+}
+exports.TaxDetails = TaxDetails;
+//# sourceMappingURL=tax-details.js.map

package/lib/models/billing/tax-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax-details.js","sourceRoot":"","sources":["../../../src/models/billing/tax-details.ts"],"names":[],"mappings":";;;AAEA,MAAa,UAAU;IACrB,QAAQ,CAAW;IACnB,QAAQ,CAAU;IAClB,iDAAiD;IACjD,cAAc,CAAU;CACzB;AALD,gCAKC"}

package/lib/models/taxes/index.d.ts

@@ -1,2 +1,3 @@
 export * from './tax-identifier-type';
 export * from './tax-identifier';
+export * from './tax-type';

package/lib/models/taxes/index.js

@@ -3,4 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./tax-identifier-type"), exports);
 tslib_1.__exportStar(require("./tax-identifier"), exports);
+tslib_1.__exportStar(require("./tax-type"), exports);
 //# sourceMappingURL=index.js.map

package/lib/models/taxes/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/taxes/index.ts"],"names":[],"mappings":";;;AAAA,gEAAsC;AACtC,2DAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/taxes/index.ts"],"names":[],"mappings":";;;AAAA,gEAAsC;AACtC,2DAAiC;AACjC,qDAA2B"}

package/lib/models/taxes/tax-type.d.ts

@@ -0,0 +1,3 @@
+export declare enum TaxType {
+    VAT = "vat"
+}

package/lib/models/taxes/tax-type.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaxType = void 0;
+var TaxType;
+(function (TaxType) {
+    TaxType["VAT"] = "vat";
+})(TaxType || (exports.TaxType = TaxType = {}));
+//# sourceMappingURL=tax-type.js.map

package/lib/models/taxes/tax-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax-type.js","sourceRoot":"","sources":["../../../src/models/taxes/tax-type.ts"],"names":[],"mappings":";;;AAAA,IAAY,OAEX;AAFD,WAAY,OAAO;IACjB,sBAAW,CAAA;AACb,CAAC,EAFW,OAAO,uBAAP,OAAO,QAElB"}

package/lib/models/tracking/proof-of-delivery-format-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const ProofOfDeliveryFormatSchema: Joi.StringSchema;

package/lib/models/tracking/proof-of-delivery-format-schema.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProofOfDeliveryFormatSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const proof_of_delivery_format_1 = require("./proof-of-delivery-format");
+exports.ProofOfDeliveryFormatSchema = joi_1.default.string().valid(...Object.values(proof_of_delivery_format_1.ProofOfDeliveryFormat));
+//# sourceMappingURL=proof-of-delivery-format-schema.js.map

package/lib/models/tracking/proof-of-delivery-format-schema.js.map

@@ -0,0 +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"}

package/lib/models/tracking/proof-of-delivery-format.d.ts

@@ -0,0 +1,4 @@
+export declare enum ProofOfDeliveryFormat {
+    Pdf = "PDF",
+    Png = "PNG"
+}

package/lib/models/tracking/proof-of-delivery-format.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProofOfDeliveryFormat = void 0;
+var ProofOfDeliveryFormat;
+(function (ProofOfDeliveryFormat) {
+    ProofOfDeliveryFormat["Pdf"] = "PDF";
+    ProofOfDeliveryFormat["Png"] = "PNG";
+})(ProofOfDeliveryFormat || (exports.ProofOfDeliveryFormat = ProofOfDeliveryFormat = {}));
+//# sourceMappingURL=proof-of-delivery-format.js.map

package/lib/models/tracking/proof-of-delivery-format.js.map

@@ -0,0 +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"}

package/lib/models/tracking/proof-of-delivery-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const ProofOfDeliverySchema: Joi.ObjectSchema<any>;

package/lib/models/tracking/proof-of-delivery-schema.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProofOfDeliverySchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const proof_of_delivery_format_schema_1 = require("./proof-of-delivery-format-schema");
+exports.ProofOfDeliverySchema = joi_1.default.object({
+    data: joi_1.default.string().required(),
+    format: proof_of_delivery_format_schema_1.ProofOfDeliveryFormatSchema.required(),
+});
+//# sourceMappingURL=proof-of-delivery-schema.js.map

package/lib/models/tracking/proof-of-delivery-schema.js.map

@@ -0,0 +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"}

package/lib/models/tracking/proof-of-delivery.d.ts

@@ -0,0 +1,8 @@
+import { ProofOfDeliveryFormat } from './proof-of-delivery-format';
+/** @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. */
+export declare class ProofOfDelivery {
+    /** @description Base64 encoded data for the proof of delivery. */
+    data: string;
+    /** @description The format the document is in.\r\nPdf - PDF\r\nPng - PNG */
+    format: ProofOfDeliveryFormat;
+}

package/lib/models/tracking/proof-of-delivery.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProofOfDelivery = void 0;
+/** @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. */
+class ProofOfDelivery {
+    /** @description Base64 encoded data for the proof of delivery. */
+    data;
+    /** @description The format the document is in.\r\nPdf - PDF\r\nPng - PNG */
+    format;
+}
+exports.ProofOfDelivery = ProofOfDelivery;
+//# sourceMappingURL=proof-of-delivery.js.map

package/lib/models/tracking/proof-of-delivery.js.map

@@ -0,0 +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"}

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

@@ -6,11 +6,13 @@ const joi_1 = tslib_1.__importDefault(require("joi"));
 const lat_long_schema_1 = require("./lat-long-schema");
 const standardized_status_codes_schema_1 = require("./standardized-status-codes-schema");
 const standardized_status_detail_codes_schema_1 = require("./standardized-status-detail-codes-schema");
+const proof_of_delivery_schema_1 = require("./proof-of-delivery-schema");
 exports.TrackEventSchema = joi_1.default.object({
     event_datetime: joi_1.default.string().optional().empty().isoDate(),
     event_datetime_local: joi_1.default.string().optional().empty().isoDate(),
     event_code: joi_1.default.string().optional().empty(),
     carrier_detail_code: joi_1.default.string().optional().empty(),
+    proof_of_delivery: proof_of_delivery_schema_1.ProofOfDeliverySchema.optional(),
     description: joi_1.default.string().optional().empty(),
     city: joi_1.default.string().optional().empty(),
     state: joi_1.default.string().optional().empty(),

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

@@ -1 +1 @@
-{"version":3,"file":"track-event-schema.js","sourceRoot":"","sources":["../../../src/models/tracking/track-event-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,uDAAkD;AAClD,yFAAmF;AACnF,uGAAgG;AAEnF,QAAA,gBAAgB,GAAG,aAAG,CAAC,MAAM,CAAC;IACzC,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACzD,oBAAoB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC/D,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3C,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"}
+{"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"}

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

@@ -1,6 +1,7 @@
 import { LatLong } from './lat-long';
 import { StandardizedStatusCodes } from './standardized-status-codes';
 import { StandardizedStatusDetailCodes } from './standardized-status-detail-codes';
+import { ProofOfDelivery } from './proof-of-delivery';
 /** @description Basic structure for tracking events */
 export declare class TrackEvent {
     /** @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 {
     event_code?: string;
     /** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
     carrier_detail_code?: string;
+    /** @description 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. */
+    proof_of_delivery?: ProofOfDelivery;
     /** @description Description of the package status at this event */
     description?: string;
     /** @description City or Locality for this event */

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

@@ -11,6 +11,8 @@ class TrackEvent {
     event_code;
     /** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
     carrier_detail_code;
+    /** @description 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. */
+    proof_of_delivery;
     /** @description Description of the package status at this event */
     description;
     /** @description City or Locality for this event */

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

@@ -1 +1 @@
-{"version":3,"file":"track-event.js","sourceRoot":"","sources":["../../../src/models/tracking/track-event.ts"],"names":[],"mappings":";;;AAIA,uDAAuD;AACvD,MAAa,UAAU;IACrB,yHAAyH;IACzH,cAAc,CAAU;IACxB,sIAAsI;IACtI,oBAAoB,CAAU;IAC9B,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"}
+{"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

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.12.2",
+  "version": "4.14.0",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",

package/spec.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Shipping API",
     "description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
-    "version": "1.25.2"
+    "version": "1.27.0"
   },
   "paths": {
     "/Register": {
@@ -1005,7 +1005,7 @@
           },
           "memo": {
             "type": "string",
-            "description": "Maximum length of 250 characters. This will often be empty; however, if there was additionally specific information about the charge it should go here, could also be a reference number. Maximum length of 250 characters.",
+            "description": "This will often be empty; however, if there was additionally specific information about the charge it should go here, could also be a reference number. Maximum length of 250 characters.",
             "nullable": true
           },
           "amount": {
@@ -1026,6 +1026,9 @@
             },
             "description": "Total amount of the line item to be billed to the end customer.",
             "nullable": true
+          },
+          "tax_details": {
+            "$ref": "#/components/schemas/TaxDetails"
           }
         },
         "additionalProperties": false
@@ -4353,6 +4356,52 @@
         "type": "string",
         "description": "This represents the ShipEngine supported detail codes for a shipment."
       },
+      "ProofOfDelivery": {
+        "required": [
+          "data",
+          "format"
+        ],
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "string",
+            "description": "Base64 encoded data for the proof of delivery.",
+            "nullable": true
+          },
+          "format": {
+            "$ref": "#/components/schemas/ProofOfDeliveryFormat"
+          }
+        },
+        "additionalProperties": false,
+        "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."
+      },
+      "ProofOfDeliveryFormat": {
+        "enum": [
+          "PDF",
+          "PNG"
+        ],
+        "type": "string",
+        "description": "The format the document is in.\r\nPdf - PDF\r\nPng - PNG"
+      },
+      "TaxDetails": {
+        "type": "object",
+        "properties": {
+          "tax_type": {
+            "$ref": "#/components/schemas/TaxType"
+          },
+          "tax_code": {
+            "type": "string",
+            "nullable": true
+          },
+          "tax_percentage": {
+            "type": "number",
+            "description": "Tax percentage, e.g. 20, 23.7",
+            "format": "double",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
       "TaxIdentificationType": {
         "enum": [
           "tin",
@@ -4401,6 +4450,12 @@
         "additionalProperties": false,
         "description": "Entity representing a Tax Identification number, type, and country of registration."
       },
+      "TaxType": {
+        "enum": [
+          "vat"
+        ],
+        "type": "string"
+      },
       "TermsOfTradeCode": {
         "enum": [
           "exw",
@@ -4514,6 +4569,9 @@
           },
           "status_detail_code": {
             "$ref": "#/components/schemas/StandardizedStatusDetailCodes"
+          },
+          "proof_of_delivery": {
+            "$ref": "#/components/schemas/ProofOfDelivery"
           }
         },
         "additionalProperties": false,

package/src/app/metadata/carrier-attributes.ts

@@ -7,6 +7,7 @@ export enum CarrierAttributeEnum {
   Regional = 'Regional',
   RequiresInboundWebhook = 'RequiresInboundWebhook',
   DetailedStatuses = 'DetailedStatuses',
+  ProofOfDelivery = 'ProofOfDelivery',
 }
 
 export const CarrierAttributeEnumSchema = Joi.string().valid(

package/src/app/metadata/enums.ts

@@ -5,6 +5,7 @@ export enum CarrierAttribute {
   Regional = 'Regional',
   RequiresInboundWebhook = 'RequiresInboundWebhook',
   DetailedStatuses = 'DetailedStatuses',
+  ProofOfDelivery = 'ProofOfDelivery',
 }
 
 export enum ShippingServiceAttribute {

package/src/models/billing/billing-line-item.ts

@@ -1,5 +1,6 @@
 import { BillingCategories } from './billing-categories';
 import { Currency } from '../currency';
+import { TaxDetails } from './tax-details';
 
 /** @description Basic structure of each charge or line item */
 export class BillingLineItem {
@@ -15,4 +16,6 @@ export class BillingLineItem {
   amount!: Currency;
   /** @description Total amount of the line item billed by the provider. This should only be populated if it differs from 'amount' **/
   provider_billed_amount?: Currency;
+  /** @description Optional field. This field is applicable only to items that represent tax charge. It contains details about the tax, e.g. type (VAT), etc. */
+  tax_details?: TaxDetails;
 }

package/src/models/billing/index.ts

@@ -3,3 +3,4 @@ export * from './billing-categories-schema';
 export * from './billing-line-item';
 export * from './billing-line-item-schema';
 export * from './billing-to-party';
+export * from './tax-details';

package/src/models/billing/tax-details.ts

@@ -0,0 +1,8 @@
+import { TaxType } from '../taxes';
+
+export class TaxDetails {
+  tax_type?: TaxType;
+  tax_code?: string;
+  /** @description Tax percentage, e.g. 20, 23.7 */
+  tax_percentage?: number;
+}

package/src/models/taxes/index.ts

@@ -1,2 +1,3 @@
 export * from './tax-identifier-type';
 export * from './tax-identifier';
+export * from './tax-type';

package/src/models/taxes/tax-type.ts

@@ -0,0 +1,3 @@
+export enum TaxType {
+  VAT = 'vat',
+}

package/src/models/tracking/proof-of-delivery-format-schema.ts

@@ -0,0 +1,6 @@
+import Joi from 'joi';
+import { ProofOfDeliveryFormat } from './proof-of-delivery-format';
+
+export const ProofOfDeliveryFormatSchema = Joi.string().valid(
+  ...Object.values(ProofOfDeliveryFormat),
+);

package/src/models/tracking/proof-of-delivery-format.ts

@@ -0,0 +1,4 @@
+export enum ProofOfDeliveryFormat {
+  Pdf = 'PDF',
+  Png = 'PNG',
+}

package/src/models/tracking/proof-of-delivery-schema.ts

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+import { ProofOfDeliveryFormatSchema } from './proof-of-delivery-format-schema';
+
+export const ProofOfDeliverySchema = Joi.object({
+  data: Joi.string().required(),
+  format: ProofOfDeliveryFormatSchema.required(),
+});

package/src/models/tracking/proof-of-delivery.ts

@@ -0,0 +1,9 @@
+import { ProofOfDeliveryFormat } from './proof-of-delivery-format';
+
+/** @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. */
+export class ProofOfDelivery {
+  /** @description Base64 encoded data for the proof of delivery. */
+  data!: string;
+  /** @description The format the document is in.\r\nPdf - PDF\r\nPng - PNG */
+  format!: ProofOfDeliveryFormat;
+}

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

@@ -2,12 +2,14 @@ import Joi from 'joi';
 import { LatLongSchema } from './lat-long-schema';
 import { StandardizedStatusCodesSchema } from './standardized-status-codes-schema';
 import { StandardizedStatusDetailCodesSchema } from './standardized-status-detail-codes-schema';
+import { ProofOfDeliverySchema } from './proof-of-delivery-schema';
 
 export const TrackEventSchema = Joi.object({
   event_datetime: Joi.string().optional().empty().isoDate(),
   event_datetime_local: Joi.string().optional().empty().isoDate(),
   event_code: Joi.string().optional().empty(),
   carrier_detail_code: Joi.string().optional().empty(),
+  proof_of_delivery: ProofOfDeliverySchema.optional(),
   description: Joi.string().optional().empty(),
   city: Joi.string().optional().empty(),
   state: Joi.string().optional().empty(),

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

@@ -1,6 +1,7 @@
 import { LatLong } from './lat-long';
 import { StandardizedStatusCodes } from './standardized-status-codes';
 import { StandardizedStatusDetailCodes } from './standardized-status-detail-codes';
+import { ProofOfDelivery } from './proof-of-delivery';
 
 /** @description Basic structure for tracking events */
 export class TrackEvent {
@@ -12,6 +13,8 @@ export class TrackEvent {
   event_code?: string;
   /** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
   carrier_detail_code?: string;
+  /** @description 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. */
+  proof_of_delivery?: ProofOfDelivery;
   /** @description Description of the package status at this event */
   description?: string;
   /** @description City or Locality for this event */