@shipengine/connect-carrier-api 2.2.2 → 2.2.3

package/lib/models/addresses/address-base.d.ts

@@ -1,35 +1,35 @@
 import { AddressResidentialIndicator } from './address-residential-indicator';
 export declare class AddressBase {
-    /** @description Name of the contact */
+    /** @description The full name of the contact contact associated with the address */
     name?: string;
-    /** @description First or given name of the contact */
+    /** @description The first name of the contact associated with the address */
     first_name?: string;
-    /** @description Last or family name of the contact  */
+    /** @description The last name of the contact associated with the address */
     last_name?: string;
-    /** @description Email of the contact */
+    /** @description The email of the contact associated with the address */
     email?: string;
-    /** @description Phone number of the contact. Cannot include newline chars. */
+    /** @description The phone number of the contact associated with the address (No Newline Characters) */
     phone_number?: string;
-    /** @description Company name, if applicable. Cannot include newline chars. */
+    /** @description The name of the company associated with this address (No Newline Characters) max length 100 characters */
     company_name?: string;
-    /** @description Address fields separated by line. Up to 100 chars per line. Cannot include newline chars. */
+    /** @description The address lines of the address (No Newline Characters) max length 100 characters */
     address_lines?: string[];
-    /** @description City or locality. Cannot contain newline chars. */
+    /** @description City or locality (No Newline Characters) */
     city_locality?: string;
-    /** @description State or province. Cannot contain newline chars. */
+    /** @description State or province (No Newline Characters) */
     state_province?: string;
-    /** @description Zip or postal code. Cannot include newline chars. */
+    /** @description Zip or postal code (No Newline Characters) */
     postal_code: string;
-    /** @description ISO 3166-1 two-letter country code  */
+    /** @description ISO 3166-1 two-letter country code max length 2 characters  */
     country_code: string;
     /** @description Whether the address is residential or commercial */
     address_residential_indicator?: AddressResidentialIndicator;
     /** @description Whether the country of the shipment address is a member of the EU */
     is_eu?: boolean;
-    /** @description Metadata for this address */
+    /** @description Additional metadata provided for specific requests */
     address_metadata?: {
         [key: string]: string;
     };
-    /** @description Instructions to help the carrier navigate to the address. */
+    /** @description Instructions to help the carrier navigate to the address */
     instructions?: string;
 }

package/lib/models/addresses/address-base.js.map

@@ -1 +1 @@
-{"version":3,"file":"address-base.js","sourceRoot":"","sources":["../../../src/models/addresses/address-base.ts"],"names":[],"mappings":";;;AAEA,MAAa,WAAW;CAgCvB;AAhCD,kCAgCC"}
+{"version":3,"file":"address-base.js","sourceRoot":"","sources":["../../../src/models/addresses/address-base.ts"],"names":[],"mappings":";;;AAEA,MAAa,WAAW;CA+BvB;AA/BD,kCA+BC"}

package/lib/models/addresses/address-residential-indicator.d.ts

@@ -1,6 +1,9 @@
 /** @description Used for indicating whether an address is residential or commercial */
 export declare enum AddressResidentialIndicator {
+    /** @description Indicates that it is unknown whether or not the address is in a residential or commercial area */
     Unknown = "unknown",
+    /** @description Indicates that the address is in a residential area */
     Yes = "yes",
+    /** @description Indicates that the address is not in a residential area */
     No = "no"
 }

package/lib/models/addresses/address-residential-indicator.js

@@ -4,8 +4,11 @@ exports.AddressResidentialIndicator = void 0;
 /** @description Used for indicating whether an address is residential or commercial */
 var AddressResidentialIndicator;
 (function (AddressResidentialIndicator) {
+    /** @description Indicates that it is unknown whether or not the address is in a residential or commercial area */
     AddressResidentialIndicator["Unknown"] = "unknown";
+    /** @description Indicates that the address is in a residential area */
     AddressResidentialIndicator["Yes"] = "yes";
+    /** @description Indicates that the address is not in a residential area */
     AddressResidentialIndicator["No"] = "no";
 })(AddressResidentialIndicator = exports.AddressResidentialIndicator || (exports.AddressResidentialIndicator = {}));
 //# sourceMappingURL=address-residential-indicator.js.map

package/lib/models/addresses/address-residential-indicator.js.map

@@ -1 +1 @@
-{"version":3,"file":"address-residential-indicator.js","sourceRoot":"","sources":["../../../src/models/addresses/address-residential-indicator.ts"],"names":[],"mappings":";;;AAAA,uFAAuF;AACvF,IAAY,2BAIX;AAJD,WAAY,2BAA2B;IACrC,kDAAmB,CAAA;IACnB,0CAAW,CAAA;IACX,wCAAS,CAAA;AACX,CAAC,EAJW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAItC"}
+{"version":3,"file":"address-residential-indicator.js","sourceRoot":"","sources":["../../../src/models/addresses/address-residential-indicator.ts"],"names":[],"mappings":";;;AAAA,uFAAuF;AACvF,IAAY,2BAOX;AAPD,WAAY,2BAA2B;IACrC,kHAAkH;IAClH,kDAAmB,CAAA;IACnB,uEAAuE;IACvE,0CAAW,CAAA;IACX,2EAA2E;IAC3E,wCAAS,CAAA;AACX,CAAC,EAPW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAOtC"}

package/lib/models/addresses/ship-from-display.d.ts

@@ -1,3 +1,4 @@
 import { AddressBase } from './address-base';
+/** @description The address that should be displayed on the label as the ship from location */
 export declare class ShipFromDisplay extends AddressBase {
 }

package/lib/models/addresses/ship-from-display.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShipFromDisplay = void 0;
 const address_base_1 = require("./address-base");
+/** @description The address that should be displayed on the label as the ship from location */
 class ShipFromDisplay extends address_base_1.AddressBase {
 }
 exports.ShipFromDisplay = ShipFromDisplay;

package/lib/models/addresses/ship-from-display.js.map

@@ -1 +1 @@
-{"version":3,"file":"ship-from-display.js","sourceRoot":"","sources":["../../../src/models/addresses/ship-from-display.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAE7C,MAAa,eAAgB,SAAQ,0BAAW;CAAG;AAAnD,0CAAmD"}
+{"version":3,"file":"ship-from-display.js","sourceRoot":"","sources":["../../../src/models/addresses/ship-from-display.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAE7C,+FAA+F;AAC/F,MAAa,eAAgB,SAAQ,0BAAW;CAAG;AAAnD,0CAAmD"}

package/lib/models/addresses/ship-from.d.ts

@@ -1,5 +1,6 @@
 import { AddressBase } from './address-base';
 import { TaxIdentifier } from '../taxes/tax-identifier';
+/** @description The address for where the shipment will be shipped from */
 export declare class ShipFrom extends AddressBase {
     /** @description Tax IDs associated with the exporter */
     tax_identifiers?: TaxIdentifier[];

package/lib/models/addresses/ship-from.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShipFrom = void 0;
 const address_base_1 = require("./address-base");
+/** @description The address for where the shipment will be shipped from */
 class ShipFrom extends address_base_1.AddressBase {
 }
 exports.ShipFrom = ShipFrom;

package/lib/models/addresses/ship-from.js.map

@@ -1 +1 @@
-{"version":3,"file":"ship-from.js","sourceRoot":"","sources":["../../../src/models/addresses/ship-from.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAG7C,MAAa,QAAS,SAAQ,0BAAW;CAGxC;AAHD,4BAGC"}
+{"version":3,"file":"ship-from.js","sourceRoot":"","sources":["../../../src/models/addresses/ship-from.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAG7C,2EAA2E;AAC3E,MAAa,QAAS,SAAQ,0BAAW;CAGxC;AAHD,4BAGC"}

package/lib/models/addresses/ship-to.d.ts

@@ -1,5 +1,6 @@
 import { AddressBase } from './address-base';
 import { TaxIdentifier } from '../taxes/tax-identifier';
+/** @description The address that a shipment will be delivered to */
 export declare class ShipTo extends AddressBase {
     /** @description Tax IDs associated with the consignee */
     tax_identifiers?: TaxIdentifier[];

package/lib/models/addresses/ship-to.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShipTo = void 0;
 const address_base_1 = require("./address-base");
+/** @description The address that a shipment will be delivered to */
 class ShipTo extends address_base_1.AddressBase {
 }
 exports.ShipTo = ShipTo;

package/lib/models/addresses/ship-to.js.map

@@ -1 +1 @@
-{"version":3,"file":"ship-to.js","sourceRoot":"","sources":["../../../src/models/addresses/ship-to.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAG7C,MAAa,MAAO,SAAQ,0BAAW;CAGtC;AAHD,wBAGC"}
+{"version":3,"file":"ship-to.js","sourceRoot":"","sources":["../../../src/models/addresses/ship-to.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAG7C,oEAAoE;AACpE,MAAa,MAAO,SAAQ,0BAAW;CAGtC;AAHD,wBAGC"}

package/lib/models/advanced-options.d.ts

@@ -11,7 +11,7 @@ export declare class AdvancedOptions {
     bill_duties_to_sender?: boolean;
     /** @description Whether Saturday delivery is permissible  */
     saturday_delivery?: boolean;
-    /** @description Amount to be paid to the driver, used for local delivery and courier services. */
+    /** @description Amount to be paid to the driver, used for local delivery and courier services */
     tip?: Currency;
     /** @description Any other custom shipping options */
     [key: string]: any;

package/lib/models/authorization.d.ts

@@ -1,4 +1,6 @@
 export declare class Authorization {
+    /** @description The access token used to authorize the request */
     access_token?: string;
+    /** @description Optional - any additional information required to authorize the request */
     connection_context?: any;
 }

package/lib/models/authorization.js.map

@@ -1 +1 @@
-{"version":3,"file":"authorization.js","sourceRoot":"","sources":["../../src/models/authorization.ts"],"names":[],"mappings":";;;AAAA,MAAa,aAAa;CAGzB;AAHD,sCAGC"}
+{"version":3,"file":"authorization.js","sourceRoot":"","sources":["../../src/models/authorization.ts"],"names":[],"mappings":";;;AAAA,MAAa,aAAa;CAKzB;AALD,sCAKC"}

package/lib/models/billing/billing-categories.d.ts

@@ -21,7 +21,7 @@ export declare enum BillingCategories {
     Oversize = "oversize",
     Returns = "returns",
     Notifications = "notifications",
-    /** @description Amount to be paid to the driver, used for local delivery and courier services. */
+    /** @description Amount to be paid to the driver, used for local delivery and courier services */
     Tip = "tip"
 }
 export declare const BillingCategoriesSchema: Joi.StringSchema;

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

@@ -26,7 +26,7 @@ var BillingCategories;
     BillingCategories["Oversize"] = "oversize";
     BillingCategories["Returns"] = "returns";
     BillingCategories["Notifications"] = "notifications";
-    /** @description Amount to be paid to the driver, used for local delivery and courier services. */
+    /** @description Amount to be paid to the driver, used for local delivery and courier services */
     BillingCategories["Tip"] = "tip";
 })(BillingCategories = exports.BillingCategories || (exports.BillingCategories = {}));
 exports.BillingCategoriesSchema = joi_1.default.string().valid(...Object.values(BillingCategories));

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,CACvD,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CACpC,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,6DAG8B;AAC9B,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,CAClD,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAC/B,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,iEAGoC;AACpC,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"}