@shipengine/connect-carrier-api 2.2.2 → 2.3.1

package/lib/models/billing/billing-categories.js.map

@@ -1 +1 @@
-{"version":3,"file":"billing-categories.js","sourceRoot":"","sources":["../../../src/models/billing/billing-categories.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,oDAAoD;AACpD,IAAY,iBAuBX;AAvBD,WAAY,iBAAiB;IAC3B,oDAA+B,CAAA;IAC/B,0CAAqB,CAAA;IACrB,4CAAuB,CAAA;IACvB,oFAAoF;IACpF,wCAAmB,CAAA;IACnB,0CAAqB,CAAA;IACrB,+CAA0B,CAAA;IAC1B,uDAAkC,CAAA;IAClC,sCAAiB,CAAA;IACjB,gCAAW,CAAA;IACX,0CAAqB,CAAA;IACrB,0CAAqB,CAAA;IACrB,mDAA8B,CAAA;IAC9B,sCAAiB,CAAA;IACjB,wEAAwE;IACxE,iDAA4B,CAAA;IAC5B,iDAAiD;IACjD,0CAAqB,CAAA;IACrB,wCAAmB,CAAA;IACnB,oDAA+B,CAAA;IAC/B,kGAAkG;IAClG,gCAAW,CAAA;AACb,CAAC,EAvBW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAuB5B;AAEY,QAAA,uBAAuB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CACvD,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CACpC,CAAC"}
+{"version":3,"file":"billing-categories.js","sourceRoot":"","sources":["../../../src/models/billing/billing-categories.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,oDAAoD;AACpD,IAAY,iBAuBX;AAvBD,WAAY,iBAAiB;IAC3B,oDAA+B,CAAA;IAC/B,0CAAqB,CAAA;IACrB,4CAAuB,CAAA;IACvB,oFAAoF;IACpF,wCAAmB,CAAA;IACnB,0CAAqB,CAAA;IACrB,+CAA0B,CAAA;IAC1B,uDAAkC,CAAA;IAClC,sCAAiB,CAAA;IACjB,gCAAW,CAAA;IACX,0CAAqB,CAAA;IACrB,0CAAqB,CAAA;IACrB,mDAA8B,CAAA;IAC9B,sCAAiB,CAAA;IACjB,wEAAwE;IACxE,iDAA4B,CAAA;IAC5B,iDAAiD;IACjD,0CAAqB,CAAA;IACrB,wCAAmB,CAAA;IACnB,oDAA+B,CAAA;IAC/B,iGAAiG;IACjG,gCAAW,CAAA;AACb,CAAC,EAvBW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAuB5B;AAEY,QAAA,uBAAuB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC"}

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

@@ -3,10 +3,15 @@ import { Currency } from '../currency';
 import Joi from 'joi';
 /** @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 */
     billing_category: BillingCategories;
+    /** @description If the carrier provides a description from their API about the billing charge (not specific to the user). Maximum length of 100 characters. */
     carrier_description?: string;
+    /** @description If the carrier provides a billing code for */
     carrier_billing_code?: string;
+    /** @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. */
     memo?: string;
+    /** @description Total amount of the line item */
     amount: Currency;
 }
 export declare const BillingLineItemSchema: Joi.ObjectSchema<any>;

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

@@ -11,9 +11,9 @@ class BillingLineItem {
 exports.BillingLineItem = BillingLineItem;
 exports.BillingLineItemSchema = joi_1.default.object({
     billing_category: billing_categories_1.BillingCategoriesSchema.required(),
-    carrier_description: joi_1.default.string().optional().empty(),
+    carrier_description: joi_1.default.string().optional().empty().max(100),
     carrier_billing_code: joi_1.default.string().optional().empty(),
-    memo: joi_1.default.string().optional().empty(),
+    memo: joi_1.default.string().optional().empty().max(250),
     amount: currency_1.CurrencySchema.required(),
 });
 //# 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":";;;;AAAA,6DAG8B;AAC9B,0CAAuD;AACvD,sDAAsB;AAEtB,+DAA+D;AAC/D,MAAa,eAAe;CAM3B;AAND,0CAMC;AAEY,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,gBAAgB,EAAE,4CAAuB,CAAC,QAAQ,EAAE;IACpD,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACpD,oBAAoB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrD,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,MAAM,EAAE,yBAAc,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC"}
+{"version":3,"file":"billing-line-item.js","sourceRoot":"","sources":["../../../src/models/billing/billing-line-item.ts"],"names":[],"mappings":";;;;AAAA,6DAAkF;AAClF,0CAAuD;AACvD,sDAAsB;AAEtB,+DAA+D;AAC/D,MAAa,eAAe;CAW3B;AAXD,0CAWC;AAEY,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,gBAAgB,EAAE,4CAAuB,CAAC,QAAQ,EAAE;IACpD,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAC7D,oBAAoB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrD,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAC9C,MAAM,EAAE,yBAAc,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC"}

package/lib/models/confirmation-types.d.ts

@@ -1,13 +1,13 @@
 /** @description Types of delivery confirmation */
 export declare enum ConfirmationTypes {
-    /** @description No confirmation is requested. */
+    /** @description No confirmation is requested */
     None = "None",
-    /** @description Delivery confirmation is requested. */
+    /** @description Delivery confirmation is requested */
     Delivery = "Delivery",
-    /** @description A signature is required. This signature may be a neighbor, building manager, or the recipient can authorize the release of the package (without being present). */
+    /** @description A signature is required. This signature may be a neighbor, building manager, or the recipient can authorize the release of the package (without being present) */
     Signature = "Signature",
-    /** @description A signature of an adult is required. */
+    /** @description A signature of an adult is required */
     AdultSignature = "AdultSignature",
-    /** @description Only supported by FedEx. The signature of somebody at the address is required. */
+    /** @description Only supported by FedEx. The signature of somebody at the address is required */
     DirectSignature = "DirectSignature"
 }

package/lib/models/confirmation-types.js

@@ -4,15 +4,15 @@ exports.ConfirmationTypes = void 0;
 /** @description Types of delivery confirmation */
 var ConfirmationTypes;
 (function (ConfirmationTypes) {
-    /** @description No confirmation is requested. */
+    /** @description No confirmation is requested */
     ConfirmationTypes["None"] = "None";
-    /** @description Delivery confirmation is requested. */
+    /** @description Delivery confirmation is requested */
     ConfirmationTypes["Delivery"] = "Delivery";
-    /** @description A signature is required. This signature may be a neighbor, building manager, or the recipient can authorize the release of the package (without being present). */
+    /** @description A signature is required. This signature may be a neighbor, building manager, or the recipient can authorize the release of the package (without being present) */
     ConfirmationTypes["Signature"] = "Signature";
-    /** @description A signature of an adult is required. */
+    /** @description A signature of an adult is required */
     ConfirmationTypes["AdultSignature"] = "AdultSignature";
-    /** @description Only supported by FedEx. The signature of somebody at the address is required. */
+    /** @description Only supported by FedEx. The signature of somebody at the address is required */
     ConfirmationTypes["DirectSignature"] = "DirectSignature";
 })(ConfirmationTypes = exports.ConfirmationTypes || (exports.ConfirmationTypes = {}));
 //# sourceMappingURL=confirmation-types.js.map

package/lib/models/confirmation-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"confirmation-types.js","sourceRoot":"","sources":["../../src/models/confirmation-types.ts"],"names":[],"mappings":";;;AAAA,kDAAkD;AAClD,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,iDAAiD;IACjD,kCAAa,CAAA;IACb,uDAAuD;IACvD,0CAAqB,CAAA;IACrB,mLAAmL;IACnL,4CAAuB,CAAA;IACvB,wDAAwD;IACxD,sDAAiC,CAAA;IACjC,kGAAkG;IAClG,wDAAmC,CAAA;AACrC,CAAC,EAXW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAW5B"}
+{"version":3,"file":"confirmation-types.js","sourceRoot":"","sources":["../../src/models/confirmation-types.ts"],"names":[],"mappings":";;;AAAA,kDAAkD;AAClD,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,gDAAgD;IAChD,kCAAa,CAAA;IACb,sDAAsD;IACtD,0CAAqB,CAAA;IACrB,kLAAkL;IAClL,4CAAuB,CAAA;IACvB,uDAAuD;IACvD,sDAAiC,CAAA;IACjC,iGAAiG;IACjG,wDAAmC,CAAA;AACrC,CAAC,EAXW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAW5B"}

package/lib/models/currency.d.ts

@@ -1,7 +1,9 @@
 import Joi from 'joi';
 /** @description Basic structure for defining an amount of money and its currency */
 export declare class Currency {
+    /** @description The ISO 4217 Currency Code (USD, EUR, etc) https://www.iso.org/iso-4217-currency-codes.html */
     currency: string;
+    /** @description The amount */
     amount: string;
 }
 export declare const CurrencySchema: Joi.ObjectSchema<any>;

package/lib/models/currency.js.map

@@ -1 +1 @@
-{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../src/models/currency.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,oFAAoF;AACpF,MAAa,QAAQ;CAGpB;AAHD,4BAGC;AAEY,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC"}
+{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../src/models/currency.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,oFAAoF;AACpF,MAAa,QAAQ;CAKpB;AALD,4BAKC;AAEY,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC"}

package/lib/models/customs/customs-content-types.d.ts

@@ -1,9 +1,13 @@
 /** @description Denotes the type of content for customs  */
 export declare enum CustomsContentTypes {
+    /** @description This is generalized merchandise that someone has purchased */
     Merchandise = "merchandise",
+    /** @description Documents that are being shipped */
     Documents = "documents",
+    /** @description An item that is being shipped as a gift (not purchased) */
     Gift = "gift",
-    /** @description e.g. a flooring sample */
+    /** @description Sample goods that are being shipped */
     Sample = "sample",
+    /** @description Items that are being returned */
     ReturnedGoods = "returned_goods"
 }

package/lib/models/customs/customs-content-types.js

@@ -4,11 +4,15 @@ exports.CustomsContentTypes = void 0;
 /** @description Denotes the type of content for customs  */
 var CustomsContentTypes;
 (function (CustomsContentTypes) {
+    /** @description This is generalized merchandise that someone has purchased */
     CustomsContentTypes["Merchandise"] = "merchandise";
+    /** @description Documents that are being shipped */
     CustomsContentTypes["Documents"] = "documents";
+    /** @description An item that is being shipped as a gift (not purchased) */
     CustomsContentTypes["Gift"] = "gift";
-    /** @description e.g. a flooring sample */
+    /** @description Sample goods that are being shipped */
     CustomsContentTypes["Sample"] = "sample";
+    /** @description Items that are being returned */
     CustomsContentTypes["ReturnedGoods"] = "returned_goods";
 })(CustomsContentTypes = exports.CustomsContentTypes || (exports.CustomsContentTypes = {}));
 //# sourceMappingURL=customs-content-types.js.map

package/lib/models/customs/customs-content-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"customs-content-types.js","sourceRoot":"","sources":["../../../src/models/customs/customs-content-types.ts"],"names":[],"mappings":";;;AAAA,4DAA4D;AAC5D,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,kDAA2B,CAAA;IAC3B,8CAAuB,CAAA;IACvB,oCAAa,CAAA;IACb,0CAA0C;IAC1C,wCAAiB,CAAA;IACjB,uDAAgC,CAAA;AAClC,CAAC,EAPW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAO9B"}
+{"version":3,"file":"customs-content-types.js","sourceRoot":"","sources":["../../../src/models/customs/customs-content-types.ts"],"names":[],"mappings":";;;AAAA,4DAA4D;AAC5D,IAAY,mBAWX;AAXD,WAAY,mBAAmB;IAC7B,8EAA8E;IAC9E,kDAA2B,CAAA;IAC3B,oDAAoD;IACpD,8CAAuB,CAAA;IACvB,2EAA2E;IAC3E,oCAAa,CAAA;IACb,uDAAuD;IACvD,wCAAiB,CAAA;IACjB,iDAAiD;IACjD,uDAAgC,CAAA;AAClC,CAAC,EAXW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAW9B"}

package/lib/models/customs/customs-item.d.ts

@@ -1,13 +1,21 @@
 import { Currency } from '../currency';
 import { WeightDetails } from '../units';
-/** @description Basic structure of an item in a customs declaration */
+/** @description This model represents the customs declaration for a single item */
 export declare class CustomsItem {
+    /** @description A user specified free form string describing this customs item. If the field is absent the user has not specified a description */
     description?: string;
+    /** @description The user specified count of items in this declaration. This value should be 1 or greater */
     quantity?: number;
+    /** @description The user specified declared customs value of this customs item. Generally, this value needs to be greater than 0 to be accepted through customs */
     value?: Currency;
+    /** @description The user specified declared country of origin of this customs item */
     country_of_origin?: string;
+    /** @description The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information */
     harmonized_tariff_code?: string;
+    /** @description The user specified SKU of this customs item. This field is completely free form. */
     sku?: string;
+    /** @description The user specified SKU description of this customs item. This field is completely free form. */
     sku_description?: string;
+    /** @description Detailed information about the weight of this item */
     item_weight?: WeightDetails;
 }

package/lib/models/customs/customs-item.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomsItem = void 0;
-/** @description Basic structure of an item in a customs declaration */
+/** @description This model represents the customs declaration for a single item */
 class CustomsItem {
 }
 exports.CustomsItem = CustomsItem;

package/lib/models/customs/customs-item.js.map

@@ -1 +1 @@
-{"version":3,"file":"customs-item.js","sourceRoot":"","sources":["../../../src/models/customs/customs-item.ts"],"names":[],"mappings":";;;AAGA,uEAAuE;AACvE,MAAa,WAAW;CASvB;AATD,kCASC"}
+{"version":3,"file":"customs-item.js","sourceRoot":"","sources":["../../../src/models/customs/customs-item.ts"],"names":[],"mappings":";;;AAGA,mFAAmF;AACnF,MAAa,WAAW;CAiBvB;AAjBD,kCAiBC"}

package/lib/models/customs/customs-non-delivery.d.ts

@@ -1,5 +1,7 @@
 /** @description Denotes the action that should be taken when a shipment is not deliverable */
 export declare enum CustomsNonDelivery {
+    /** @description Make an attempt to return this package to sender if unable to deliver */
     ReturnToSender = "return_to_sender",
+    /** @description Do not make an attempt to return this package to sender if unable to deliver */
     TreatAsAbandoned = "treat_as_abandoned"
 }

package/lib/models/customs/customs-non-delivery.js

@@ -4,7 +4,9 @@ exports.CustomsNonDelivery = void 0;
 /** @description Denotes the action that should be taken when a shipment is not deliverable */
 var CustomsNonDelivery;
 (function (CustomsNonDelivery) {
+    /** @description Make an attempt to return this package to sender if unable to deliver */
     CustomsNonDelivery["ReturnToSender"] = "return_to_sender";
+    /** @description Do not make an attempt to return this package to sender if unable to deliver */
     CustomsNonDelivery["TreatAsAbandoned"] = "treat_as_abandoned";
 })(CustomsNonDelivery = exports.CustomsNonDelivery || (exports.CustomsNonDelivery = {}));
 //# sourceMappingURL=customs-non-delivery.js.map

package/lib/models/customs/customs-non-delivery.js.map

@@ -1 +1 @@
-{"version":3,"file":"customs-non-delivery.js","sourceRoot":"","sources":["../../../src/models/customs/customs-non-delivery.ts"],"names":[],"mappings":";;;AAAA,8FAA8F;AAC9F,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,yDAAmC,CAAA;IACnC,6DAAuC,CAAA;AACzC,CAAC,EAHW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAG7B"}
+{"version":3,"file":"customs-non-delivery.js","sourceRoot":"","sources":["../../../src/models/customs/customs-non-delivery.ts"],"names":[],"mappings":";;;AAAA,8FAA8F;AAC9F,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,yFAAyF;IACzF,yDAAmC,CAAA;IACnC,gGAAgG;IAChG,6DAAuC,CAAA;AACzC,CAAC,EALW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAK7B"}

package/lib/models/customs/customs.d.ts

@@ -2,11 +2,16 @@ import { CustomsContentTypes } from './customs-content-types';
 import { CustomsNonDelivery } from './customs-non-delivery';
 import { CustomsItem } from './customs-item';
 import { Currency } from '../currency';
-/** @description Basic structure for a customs declaration. */
+/** @description Basic structure for a customs declaration */
 export declare class Customs {
+    /** @description Indicates the type of contents associated with this shipment */
     contents?: CustomsContentTypes;
+    /** @description Indicates what the seller would like done in case of an issue with delivery */
     non_delivery?: CustomsNonDelivery;
+    /** @description A list of customs items to declare */
     customs_items: CustomsItem[];
+    /** @description Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper. */
     buyer_shipping_amount_paid?: Currency;
+    /** @description The amount of duties paid by the shipper, if any. This is generally only necessary for DDP (bill_duties_to_sender) shipments. */
     duties_paid?: Currency;
 }

package/lib/models/customs/customs.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Customs = void 0;
-/** @description Basic structure for a customs declaration. */
+/** @description Basic structure for a customs declaration */
 class Customs {
 }
 exports.Customs = Customs;

package/lib/models/customs/customs.js.map

@@ -1 +1 @@
-{"version":3,"file":"customs.js","sourceRoot":"","sources":["../../../src/models/customs/customs.ts"],"names":[],"mappings":";;;AAKA,8DAA8D;AAC9D,MAAa,OAAO;CAMnB;AAND,0BAMC"}
+{"version":3,"file":"customs.js","sourceRoot":"","sources":["../../../src/models/customs/customs.ts"],"names":[],"mappings":";;;AAKA,6DAA6D;AAC7D,MAAa,OAAO;CAWnB;AAXD,0BAWC"}

package/lib/models/documents/document-type.d.ts

@@ -1,9 +1,13 @@
 import Joi from 'joi';
 /** @description Types of documents */
 export declare enum DocumentType {
+    /** @description A shipping label */
     Label = "label",
+    /** @description A form that lists the details of goods that are being imported or exported when a citizen or visitor enters a customs territory (country's borders) */
     CustomsForm = "customs_form",
+    /** @description A legal document issued by the seller (exporter) to the buyer (importer) in an international transaction and serves as a contract and a proof of sale between the buyer and seller */
     CommercialInvoice = "commercial_invoice",
+    /** @description A legal document issued by a carrier to a shipper that details the type, quantity, and destination of the goods being carried (does not indicate the ownership of goods nor does it carry a title to the goods being sold) */
     BillOfLading = "bill_of_lading"
 }
 export declare const DocumentTypeSchema: Joi.StringSchema;

package/lib/models/documents/document-type.js

@@ -6,9 +6,13 @@ const joi_1 = tslib_1.__importDefault(require("joi"));
 /** @description Types of documents */
 var DocumentType;
 (function (DocumentType) {
+    /** @description A shipping label */
     DocumentType["Label"] = "label";
+    /** @description A form that lists the details of goods that are being imported or exported when a citizen or visitor enters a customs territory (country's borders) */
     DocumentType["CustomsForm"] = "customs_form";
+    /** @description A legal document issued by the seller (exporter) to the buyer (importer) in an international transaction and serves as a contract and a proof of sale between the buyer and seller */
     DocumentType["CommercialInvoice"] = "commercial_invoice";
+    /** @description A legal document issued by a carrier to a shipper that details the type, quantity, and destination of the goods being carried (does not indicate the ownership of goods nor does it carry a title to the goods being sold) */
     DocumentType["BillOfLading"] = "bill_of_lading";
 })(DocumentType = exports.DocumentType || (exports.DocumentType = {}));
 exports.DocumentTypeSchema = joi_1.default.string().valid(...Object.values(DocumentType));

package/lib/models/documents/document-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"document-type.js","sourceRoot":"","sources":["../../../src/models/documents/document-type.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,sCAAsC;AACtC,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,+BAAe,CAAA;IACf,4CAA4B,CAAA;IAC5B,wDAAwC,CAAA;IACxC,+CAA+B,CAAA;AACjC,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAEY,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAClD,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAC/B,CAAC"}
+{"version":3,"file":"document-type.js","sourceRoot":"","sources":["../../../src/models/documents/document-type.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,sCAAsC;AACtC,IAAY,YASX;AATD,WAAY,YAAY;IACtB,oCAAoC;IACpC,+BAAe,CAAA;IACf,uKAAuK;IACvK,4CAA4B,CAAA;IAC5B,sMAAsM;IACtM,wDAAwC,CAAA;IACxC,8OAA8O;IAC9O,+CAA+B,CAAA;AACjC,CAAC,EATW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QASvB;AAEY,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC"}

package/lib/models/documents/document.d.ts

@@ -3,8 +3,11 @@ import { DocumentFormat } from '../labels/document-formats';
 import Joi from 'joi';
 /** @description Basic structure for a document */
 export declare class Document {
+    /** @description The document type(s) being returned. In most cases this is just a single document type; however, some carriers return multiple document types in the same PDF or ZPL */
     type: DocumentType[];
+    /** @description Base64 encoded data for the document */
     data: string;
+    /** @description The format the document is in (Pdf, Zpl, etc) */
     format: DocumentFormat;
 }
 export declare const DocumentSchema: Joi.ObjectSchema<any>;

package/lib/models/documents/document.js.map

@@ -1 +1 @@
-{"version":3,"file":"document.js","sourceRoot":"","sources":["../../../src/models/documents/document.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,iEAGoC;AACpC,sDAAsB;AAEtB,kDAAkD;AAClD,MAAa,QAAQ;CAIpB;AAJD,4BAIC;AACY,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,CAAC;IACvC,IAAI,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,kCAAkB,CAAC;IAC7D,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,uCAAoB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC"}
+{"version":3,"file":"document.js","sourceRoot":"","sources":["../../../src/models/documents/document.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,iEAAkF;AAClF,sDAAsB;AAEtB,kDAAkD;AAClD,MAAa,QAAQ;CAOpB;AAPD,4BAOC;AACY,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,CAAC;IACvC,IAAI,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,kCAAkB,CAAC;IAC7D,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,uCAAoB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC"}

package/lib/models/errors/detailed-error.d.ts

@@ -1,5 +1,5 @@
 import { StandardizedErrorCode } from './standardized-error-code';
-/** @description Basic structure for an error */
+/** @deprecated Please Use Runtime Errors */
 export declare class DetailedError {
     standardized_error_code: StandardizedErrorCode;
     external_error_code?: string;

package/lib/models/errors/detailed-error.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DetailedError = void 0;
-/** @description Basic structure for an error */
+/** @deprecated Please Use Runtime Errors */
 class DetailedError {
 }
 exports.DetailedError = DetailedError;

package/lib/models/errors/detailed-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"detailed-error.js","sourceRoot":"","sources":["../../../src/models/errors/detailed-error.ts"],"names":[],"mappings":";;;AAEA,gDAAgD;AAChD,MAAa,aAAa;CAMzB;AAND,sCAMC"}
+{"version":3,"file":"detailed-error.js","sourceRoot":"","sources":["../../../src/models/errors/detailed-error.ts"],"names":[],"mappings":";;;AAEA,4CAA4C;AAC5C,MAAa,aAAa;CAMzB;AAND,sCAMC"}

package/lib/models/errors/standardized-error-code.d.ts

@@ -1,4 +1,4 @@
-/** @description Error codes for DetailedError */
+/** @deprecated Please Use Runtime Errors */
 export declare enum StandardizedErrorCode {
     Generic = 0,
     Serialization = 1,

package/lib/models/errors/standardized-error-code.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StandardizedErrorCode = void 0;
-/** @description Error codes for DetailedError */
+/** @deprecated Please Use Runtime Errors */
 var StandardizedErrorCode;
 (function (StandardizedErrorCode) {
     StandardizedErrorCode[StandardizedErrorCode["Generic"] = 0] = "Generic";

package/lib/models/errors/standardized-error-code.js.map

@@ -1 +1 @@
-{"version":3,"file":"standardized-error-code.js","sourceRoot":"","sources":["../../../src/models/errors/standardized-error-code.ts"],"names":[],"mappings":";;;AAAA,iDAAiD;AACjD,IAAY,qBAcX;AAdD,WAAY,qBAAqB;IAC/B,uEAAW,CAAA;IACX,mFAAiB,CAAA;IACjB,yGAA4B,CAAA;IAC5B,6EAAc,CAAA;IACd,+FAAwB,CAAA;IACxB,mGAA0B,CAAA;IAC1B,iHAAiC,CAAA;IACjC,yGAA6B,CAAA;IAC7B,uGAA4B,CAAA;IAC5B,+FAAwB,CAAA;IACxB,+GAAgC,CAAA;IAChC,uGAA4B,CAAA;IAC5B,iGAAyB,CAAA;AAC3B,CAAC,EAdW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAchC"}
+{"version":3,"file":"standardized-error-code.js","sourceRoot":"","sources":["../../../src/models/errors/standardized-error-code.ts"],"names":[],"mappings":";;;AAAA,4CAA4C;AAC5C,IAAY,qBAcX;AAdD,WAAY,qBAAqB;IAC/B,uEAAW,CAAA;IACX,mFAAiB,CAAA;IACjB,yGAA4B,CAAA;IAC5B,6EAAc,CAAA;IACd,+FAAwB,CAAA;IACxB,mGAA0B,CAAA;IAC1B,iHAAiC,CAAA;IACjC,yGAA6B,CAAA;IAC7B,uGAA4B,CAAA;IAC5B,+FAAwB,CAAA;IACxB,+GAAgC,CAAA;IAChC,uGAA4B,CAAA;IAC5B,iGAAyB,CAAA;AAC3B,CAAC,EAdW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAchC"}

package/lib/models/fulfillment-plans/fulfillment-plan-details.d.ts

@@ -1,9 +1,12 @@
 import { Identifier } from '../identifier';
 import { FulfillmentPlanItems } from './fulfillment-plan-items';
 import { RawExternalSource } from './raw-external-source';
-/** @description Basic structure for a fulfillment plan */
+/** @description This model contains information about the fulfillment plan. */
 export declare class FulfillmentPlanDetails {
+    /** @description A list of identifiers for the sales order. */
     external_sales_order_identifiers?: Identifier[];
+    /** @description Information about the fulfillment plan item. */
     items?: FulfillmentPlanItems[];
+    /** @description This model represents a raw external source of information */
     raw_external_source?: RawExternalSource;
 }

package/lib/models/fulfillment-plans/fulfillment-plan-details.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FulfillmentPlanDetails = void 0;
-/** @description Basic structure for a fulfillment plan */
+/** @description This model contains information about the fulfillment plan. */
 class FulfillmentPlanDetails {
 }
 exports.FulfillmentPlanDetails = FulfillmentPlanDetails;

package/lib/models/fulfillment-plans/fulfillment-plan-details.js.map

@@ -1 +1 @@
-{"version":3,"file":"fulfillment-plan-details.js","sourceRoot":"","sources":["../../../src/models/fulfillment-plans/fulfillment-plan-details.ts"],"names":[],"mappings":";;;AAIA,0DAA0D;AAC1D,MAAa,sBAAsB;CAIlC;AAJD,wDAIC"}
+{"version":3,"file":"fulfillment-plan-details.js","sourceRoot":"","sources":["../../../src/models/fulfillment-plans/fulfillment-plan-details.ts"],"names":[],"mappings":";;;AAIA,+EAA+E;AAC/E,MAAa,sBAAsB;CAOlC;AAPD,wDAOC"}

package/lib/models/fulfillment-plans/fulfillment-plan-items.d.ts

@@ -1,12 +1,12 @@
 import { Identifier } from '../identifier';
 /** @description Information about the fulfillment plan for a set of items */
 export declare class FulfillmentPlanItems {
-    /** @description List of identifiers for the sales order */
+    /** @description A list of identifiers for the sales order */
     external_sales_order_identifiers?: Identifier[];
-    /** @description List of identifiers specific to the selling channel */
+    /** @description A list of identifiers specific to the selling channel */
     external_product_identifiers?: Identifier[];
-    /** @description Name of the item */
+    /** @description The name of the item */
     name?: string;
-    /** @description Number of items */
+    /** @description The number of items */
     quantity?: number;
 }

package/lib/models/fulfillment-plans/raw-external-source.d.ts

@@ -1,3 +1,5 @@
+/** @description This model represents a raw external source of information. */
 export declare class RawExternalSource {
+    /** @description Canonical representation of the fulfillment plan's and/or sales order's original source */
     marketplace_code?: string;
 }

package/lib/models/fulfillment-plans/raw-external-source.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RawExternalSource = void 0;
+/** @description This model represents a raw external source of information. */
 class RawExternalSource {
 }
 exports.RawExternalSource = RawExternalSource;

package/lib/models/fulfillment-plans/raw-external-source.js.map

@@ -1 +1 @@
-{"version":3,"file":"raw-external-source.js","sourceRoot":"","sources":["../../../src/models/fulfillment-plans/raw-external-source.ts"],"names":[],"mappings":";;;AAAA,MAAa,iBAAiB;CAE7B;AAFD,8CAEC"}
+{"version":3,"file":"raw-external-source.js","sourceRoot":"","sources":["../../../src/models/fulfillment-plans/raw-external-source.ts"],"names":[],"mappings":";;;AAAA,+EAA+E;AAC/E,MAAa,iBAAiB;CAG7B;AAHD,8CAGC"}

package/lib/models/labels/document-formats.js.map

@@ -1 +1 @@
-{"version":3,"file":"document-formats.js","sourceRoot":"","sources":["../../../src/models/labels/document-formats.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,mCAAmC;AACnC,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,6BAAW,CAAA;IACX,6BAAW,CAAA;AACb,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AACY,QAAA,oBAAoB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CACpD,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CACjC,CAAC"}
+{"version":3,"file":"document-formats.js","sourceRoot":"","sources":["../../../src/models/labels/document-formats.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,mCAAmC;AACnC,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,6BAAW,CAAA;IACX,6BAAW,CAAA;AACb,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AACY,QAAA,oBAAoB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC"}

package/lib/models/labels/form-download.d.ts

@@ -1,6 +1,8 @@
 import Joi from 'joi';
 import { ResourceDownload } from '../resource-download';
+/** @description This provides any additional forms that go with the label. For example, customs forms. Exactly one of the keys should be populated. Set href is the forms should be downloaded separately. Set data if the forms are returned directly in the response. */
 export declare class FormDownload extends ResourceDownload {
+    /** @description The base64 encoded resource data. */
     form_data?: string;
 }
 export declare const FormDownloadSchema: Joi.ObjectSchema<any>;

package/lib/models/labels/form-download.js

@@ -4,6 +4,7 @@ exports.FormDownloadSchema = exports.FormDownload = void 0;
 const tslib_1 = require("tslib");
 const joi_1 = tslib_1.__importDefault(require("joi"));
 const resource_download_1 = require("../resource-download");
+/** @description This provides any additional forms that go with the label. For example, customs forms. Exactly one of the keys should be populated. Set href is the forms should be downloaded separately. Set data if the forms are returned directly in the response. */
 class FormDownload extends resource_download_1.ResourceDownload {
 }
 exports.FormDownload = FormDownload;

package/lib/models/labels/form-download.js.map

@@ -1 +1 @@
-{"version":3,"file":"form-download.js","sourceRoot":"","sources":["../../../src/models/labels/form-download.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,4DAAgF;AAEhF,MAAa,YAAa,SAAQ,oCAAgB;CAEjD;AAFD,oCAEC;AAEY,QAAA,kBAAkB,GAAG,0CAAsB,CAAC,IAAI,CAAC;IAC5D,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CAC3C,CAAC,CAAC"}
+{"version":3,"file":"form-download.js","sourceRoot":"","sources":["../../../src/models/labels/form-download.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,4DAAgF;AAEhF,2QAA2Q;AAC3Q,MAAa,YAAa,SAAQ,oCAAgB;CAGjD;AAHD,oCAGC;AAEY,QAAA,kBAAkB,GAAG,0CAAsB,CAAC,IAAI,CAAC;IAC5D,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CAC3C,CAAC,CAAC"}

package/lib/models/labels/label-download.d.ts

@@ -1,6 +1,8 @@
 import Joi from 'joi';
 import { ResourceDownload } from '../resource-download';
+/** @description This object provides the requested label that was just created. Exactly one of the keys should be populated. Set href if the label should be downloaded separately. Set data if the label is returned directly in the response. */
 export declare class LabelDownload extends ResourceDownload {
+    /** @description The base64 encoded resource data. */
     label_data?: string;
 }
 export declare const LabelDownloadSchema: Joi.ObjectSchema<any>;

package/lib/models/labels/label-download.js

@@ -4,6 +4,7 @@ exports.LabelDownloadSchema = exports.LabelDownload = void 0;
 const tslib_1 = require("tslib");
 const joi_1 = tslib_1.__importDefault(require("joi"));
 const resource_download_1 = require("../resource-download");
+/** @description This object provides the requested label that was just created. Exactly one of the keys should be populated. Set href if the label should be downloaded separately. Set data if the label is returned directly in the response. */
 class LabelDownload extends resource_download_1.ResourceDownload {
 }
 exports.LabelDownload = LabelDownload;

package/lib/models/labels/label-download.js.map

@@ -1 +1 @@
-{"version":3,"file":"label-download.js","sourceRoot":"","sources":["../../../src/models/labels/label-download.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,4DAAgF;AAEhF,MAAa,aAAc,SAAQ,oCAAgB;CAElD;AAFD,sCAEC;AAEY,QAAA,mBAAmB,GAAG,0CAAsB,CAAC,IAAI,CAAC;IAC7D,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CAC5C,CAAC,CAAC"}
+{"version":3,"file":"label-download.js","sourceRoot":"","sources":["../../../src/models/labels/label-download.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,4DAAgF;AAEhF,mPAAmP;AACnP,MAAa,aAAc,SAAQ,oCAAgB;CAGlD;AAHD,sCAGC;AAEY,QAAA,mBAAmB,GAAG,0CAAsB,CAAC,IAAI,CAAC;IAC7D,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CAC5C,CAAC,CAAC"}

package/lib/models/labels/label-package.d.ts

@@ -3,9 +3,11 @@ import { Document } from '../documents';
 import Joi from 'joi';
 /** @description Package information provided by the carrier */
 export declare class LabelPackage {
+    /** @description Tracking number for the package */
     tracking_number?: string;
     /** @description Non-tracking alternative ids associated with this package */
     alternative_identifiers?: Identifier[];
+    /** @description Documents associated with this package, if documents are not specified at a package level, use the Documents array at the CreateLabelResponse level. */
     documents?: Document[];
 }
 export declare const LabelPackageSchema: Joi.ObjectSchema<any>;

package/lib/models/labels/label-package.js.map

@@ -1 +1 @@
-{"version":3,"file":"label-package.js","sourceRoot":"","sources":["../../../src/models/labels/label-package.ts"],"names":[],"mappings":";;;;AAAA,8CAA6D;AAC7D,4CAAwD;AACxD,sDAAsB;AAEtB,+DAA+D;AAC/D,MAAa,YAAY;CAKxB;AALD,oCAKC;AAEY,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,uBAAuB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,6BAAgB,CAAC;IACvE,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,0BAAc,CAAC;CACxD,CAAC,CAAC"}
+{"version":3,"file":"label-package.js","sourceRoot":"","sources":["../../../src/models/labels/label-package.ts"],"names":[],"mappings":";;;;AAAA,8CAA6D;AAC7D,4CAAwD;AACxD,sDAAsB;AAEtB,+DAA+D;AAC/D,MAAa,YAAY;CAOxB;AAPD,oCAOC;AAEY,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,uBAAuB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,6BAAgB,CAAC;IACvE,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,0BAAc,CAAC;CACxD,CAAC,CAAC"}

package/lib/models/labels/return-label-details.d.ts

@@ -1,4 +1,5 @@
 /** @description Basic structure for a return label */
 export declare class ReturnLabelDetails {
+    /** @description A return merchandise authorization (RMA) is an associated number assigned to process the return, this number is often printed on the label, and used when the original shipper processes the inbound return. */
     rma_number?: string;
 }

package/lib/models/labels/return-label-details.js.map

@@ -1 +1 @@
-{"version":3,"file":"return-label-details.js","sourceRoot":"","sources":["../../../src/models/labels/return-label-details.ts"],"names":[],"mappings":";;;AAAA,sDAAsD;AACtD,MAAa,kBAAkB;CAE9B;AAFD,gDAEC"}
+{"version":3,"file":"return-label-details.js","sourceRoot":"","sources":["../../../src/models/labels/return-label-details.ts"],"names":[],"mappings":";;;AAAA,sDAAsD;AACtD,MAAa,kBAAkB;CAG9B;AAHD,gDAGC"}

package/lib/models/labels/void-request.d.ts

@@ -2,6 +2,8 @@ import { ShippedShipment } from '../pickup/shipped-shipment';
 import { ShipFrom } from '../addresses';
 /** @description Basic structure for a request to void a label */
 export declare class VoidRequest extends ShippedShipment {
+    /** @description Uniquely identifies this request to void a label. Must be returned in a void response. */
     void_request_id: string;
+    /** @description The location the shipment was shipped from */
     ship_from: ShipFrom;
 }

package/lib/models/labels/void-request.js.map

@@ -1 +1 @@
-{"version":3,"file":"void-request.js","sourceRoot":"","sources":["../../../src/models/labels/void-request.ts"],"names":[],"mappings":";;;AAAA,iEAA6D;AAG7D,iEAAiE;AACjE,MAAa,WAAY,SAAQ,kCAAe;CAG/C;AAHD,kCAGC"}
+{"version":3,"file":"void-request.js","sourceRoot":"","sources":["../../../src/models/labels/void-request.ts"],"names":[],"mappings":";;;AAAA,iEAA6D;AAG7D,iEAAiE;AACjE,MAAa,WAAY,SAAQ,kCAAe;CAK/C;AALD,kCAKC"}

package/lib/models/labels/void-response.d.ts

@@ -8,7 +8,7 @@ export declare class VoidResponse {
     message?: string;
     /** @description Any errors from attempting to void */
     errors?: string[];
-    /** @description Individual Billing Line items which remain after voiding the label, e.g. a cancellation fee. */
+    /** @description Individual Billing Line items which remain after voiding the label, e.g. a cancellation fee */
     billing_line_items?: BillingLineItem[];
 }
 export declare const VoidResponseSchema: Joi.ObjectSchema<any>;

package/lib/models/manifests/label.d.ts

@@ -1,5 +1,7 @@
 /** @description Basic structure of a manifest label */
 export declare class Label {
+    /** @description The carrier tracking number for this shipment */
     tracking_number?: string;
+    /** @description The carrier specific identifier for this shipment */
     carrier_transaction_id?: string;
 }

package/lib/models/manifests/label.js.map

@@ -1 +1 @@
-{"version":3,"file":"label.js","sourceRoot":"","sources":["../../../src/models/manifests/label.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,MAAa,KAAK;CAGjB;AAHD,sBAGC"}
+{"version":3,"file":"label.js","sourceRoot":"","sources":["../../../src/models/manifests/label.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,MAAa,KAAK;CAKjB;AALD,sBAKC"}

package/lib/models/manifests/manifest.d.ts

@@ -1,10 +1,14 @@
 import Joi from 'joi';
 import { ResourceDownload } from '../resource-download';
-/** @description Basic structure of a manifest */
+/** @description This model represents a single manifest created with a shipping provider. */
 export declare class Manifest {
+    /** @description The unique identifier for this manifest. */
     manifest_id?: string;
+    /** @description The resource and where it can be downloaded */
     document_download?: ResourceDownload;
+    /** @deprecated This property is no longer used please use the document_download */
     document_href?: string;
+    /** @deprecated This property is no longer used please use the document_download */
     document_data?: string;
 }
 export declare const ManifestSchema: Joi.ObjectSchema<any>;

package/lib/models/manifests/manifest.js

@@ -4,7 +4,7 @@ exports.ManifestSchema = exports.Manifest = void 0;
 const tslib_1 = require("tslib");
 const joi_1 = tslib_1.__importDefault(require("joi"));
 const resource_download_1 = require("../resource-download");
-/** @description Basic structure of a manifest */
+/** @description This model represents a single manifest created with a shipping provider. */
 class Manifest {
 }
 exports.Manifest = Manifest;

package/lib/models/manifests/manifest.js.map

@@ -1 +1 @@
-{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../../../src/models/manifests/manifest.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,4DAAgF;AAEhF,iDAAiD;AACjD,MAAa,QAAQ;CAKpB;AALD,4BAKC;AAEY,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,CAAC;IACvC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5C,iBAAiB,EAAE,0CAAsB,CAAC,QAAQ,EAAE;IACpD,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9C,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CAC/C,CAAC,CAAC"}
+{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../../../src/models/manifests/manifest.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,4DAAgF;AAEhF,6FAA6F;AAC7F,MAAa,QAAQ;CASpB;AATD,4BASC;AAEY,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,CAAC;IACvC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5C,iBAAiB,EAAE,0CAAsB,CAAC,QAAQ,EAAE;IACpD,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9C,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CAC/C,CAAC,CAAC"}