@shipengine/connect-carrier-api 4.16.8-beta.1 → 4.16.8-beta.3

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

@@ -0,0 +1,37 @@
+/** @description Category for a billing line item */
+export declare enum BillingCategories {
+    Uncategorized = "uncategorized",
+    Shipping = "shipping",
+    Insurance = "insurance",
+    /** @description Charge for delivery confirmation, e.g. requiring adult signature */
+    Confirm = "confirm",
+    Discount = "discount",
+    FuelCharge = "fuel_charge",
+    AdditionalFees = "additional_fees",
+    Tariff = "tariff",
+    Tax = "tax",
+    Delivery = "delivery",
+    Handling = "handling",
+    SpecialGoods = "special_goods",
+    Pickup = "pickup",
+    /** @description Charge for the location of the origin or destination */
+    LocationFee = "location_fee",
+    /** @description Charge for non-standard sizes */
+    Oversize = "oversize",
+    Returns = "returns",
+    Notifications = "notifications",
+    /** @description Amount to be paid to the driver, used for local delivery and courier services */
+    Tip = "tip",
+    /** @description Duties and taxes charged for the shipment; used if DDP is chosen and the carrier supports passing back the estimated duties and taxes for the shipment. */
+    DutiesAndTaxes = "duties_and_taxes",
+    /** @description Fee for managing the import/export process, often separate from duties and taxes. */
+    BrokerageFee = "brokerage_fee",
+    /** @description Penalty for providing incorrect information when creating the shipment. For Adjustments use only. */
+    AdminFee = "admin_fee",
+    /** @description Carrier-assessed adjustment different from the original quote. For Adjustments use only. */
+    Adjustment = "adjustment",
+    /** @description Auctane service fee charged to the merchant for using the Auctane Fulfillment Logistics Wallet service. For Adjustments use only. */
+    AuctaneServiceFee = "auctane_service_fee",
+    /** @description Auctane Fulfillment Provider's price to charge the merchant for fulfilling the order. For Adjustments use only. */
+    ProductPrice = "product_price"
+}

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

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingCategories = void 0;
+/** @description Category for a billing line item */
+var BillingCategories;
+(function (BillingCategories) {
+    BillingCategories["Uncategorized"] = "uncategorized";
+    BillingCategories["Shipping"] = "shipping";
+    BillingCategories["Insurance"] = "insurance";
+    /** @description Charge for delivery confirmation, e.g. requiring adult signature */
+    BillingCategories["Confirm"] = "confirm";
+    BillingCategories["Discount"] = "discount";
+    BillingCategories["FuelCharge"] = "fuel_charge";
+    BillingCategories["AdditionalFees"] = "additional_fees";
+    BillingCategories["Tariff"] = "tariff";
+    BillingCategories["Tax"] = "tax";
+    BillingCategories["Delivery"] = "delivery";
+    BillingCategories["Handling"] = "handling";
+    BillingCategories["SpecialGoods"] = "special_goods";
+    BillingCategories["Pickup"] = "pickup";
+    /** @description Charge for the location of the origin or destination */
+    BillingCategories["LocationFee"] = "location_fee";
+    /** @description Charge for non-standard sizes */
+    BillingCategories["Oversize"] = "oversize";
+    BillingCategories["Returns"] = "returns";
+    BillingCategories["Notifications"] = "notifications";
+    /** @description Amount to be paid to the driver, used for local delivery and courier services */
+    BillingCategories["Tip"] = "tip";
+    /** @description Duties and taxes charged for the shipment; used if DDP is chosen and the carrier supports passing back the estimated duties and taxes for the shipment. */
+    BillingCategories["DutiesAndTaxes"] = "duties_and_taxes";
+    /** @description Fee for managing the import/export process, often separate from duties and taxes. */
+    BillingCategories["BrokerageFee"] = "brokerage_fee";
+    /** @description Penalty for providing incorrect information when creating the shipment. For Adjustments use only. */
+    BillingCategories["AdminFee"] = "admin_fee";
+    /** @description Carrier-assessed adjustment different from the original quote. For Adjustments use only. */
+    BillingCategories["Adjustment"] = "adjustment";
+    /** @description Auctane service fee charged to the merchant for using the Auctane Fulfillment Logistics Wallet service. For Adjustments use only. */
+    BillingCategories["AuctaneServiceFee"] = "auctane_service_fee";
+    /** @description Auctane Fulfillment Provider's price to charge the merchant for fulfilling the order. For Adjustments use only. */
+    BillingCategories["ProductPrice"] = "product_price";
+})(BillingCategories || (exports.BillingCategories = BillingCategories = {}));
+//# sourceMappingURL=billing-categories.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"billing-categories.js","sourceRoot":"","sources":["../../../src/models/billing/billing-categories.ts"],"names":[],"mappings":";;;AAAA,oDAAoD;AACpD,IAAY,iBAmCX;AAnCD,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;IACX,2KAA2K;IAC3K,wDAAmC,CAAA;IACnC,qGAAqG;IACrG,mDAA8B,CAAA;IAC9B,qHAAqH;IACrH,2CAAsB,CAAA;IACtB,4GAA4G;IAC5G,8CAAyB,CAAA;IACzB,qJAAqJ;IACrJ,8DAAyC,CAAA;IACzC,mIAAmI;IACnI,mDAA8B,CAAA;AAChC,CAAC,EAnCW,iBAAiB,iCAAjB,iBAAiB,QAmC5B"}

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

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

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingLineItemSchema = void 0;
+const tslib_1 = require("tslib");
+const billing_categories_schema_1 = require("./billing-categories-schema");
+const currency_schema_1 = require("../currency-schema");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+exports.BillingLineItemSchema = joi_1.default.object({
+    billing_category: billing_categories_schema_1.BillingCategoriesSchema.required(),
+    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().max(250),
+    amount: currency_schema_1.CurrencySchema.required(),
+    provider_billed_amount: currency_schema_1.CurrencySchema.optional(),
+});
+//# sourceMappingURL=billing-line-item-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"billing-line-item-schema.js","sourceRoot":"","sources":["../../../src/models/billing/billing-line-item-schema.ts"],"names":[],"mappings":";;;;AAAA,2EAAsE;AACtE,wDAAoD;AACpD,sDAAsB;AAET,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,gBAAgB,EAAE,mDAAuB,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,gCAAc,CAAC,QAAQ,EAAE;IACjC,sBAAsB,EAAE,gCAAc,CAAC,QAAQ,EAAE;CAClD,CAAC,CAAC"}

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

@@ -0,0 +1,20 @@
+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 */
+    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 displayed and charged to the buyer */
+    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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingLineItem = void 0;
+/** @description Basic structure of each charge or line item */
+class BillingLineItem {
+    /** A generalized category for what type of billing line item this is */
+    billing_category;
+    /** @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;
+    /** @description If the carrier provides a billing code for */
+    carrier_billing_code;
+    /** @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;
+    /** @description Total amount of the line item displayed and charged to the buyer */
+    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

@@ -0,0 +1 @@
+{"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/billing-to-party.d.ts

@@ -0,0 +1,10 @@
+/** @description The type of party responsible for a given category of charges associated with a shipment, such as
+ * shipping charges or import duties. */
+export declare enum BillToParty {
+    /** @description The shipper is generally regarded as the party responsible for the billing. */
+    Shipper = "shipper",
+    /** @description The recipient may be responsible for the billing of some entities, that could include the shipping cost. */
+    Recipient = "recipient",
+    /** @description A shipper may want to bill to a third-party; especially common for 3PLs and larger volume. merchants */
+    ThirdPartyAccount = "third_party_account"
+}

package/lib/models/billing/billing-to-party.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillToParty = void 0;
+/** @description The type of party responsible for a given category of charges associated with a shipment, such as
+ * shipping charges or import duties. */
+var BillToParty;
+(function (BillToParty) {
+    /** @description The shipper is generally regarded as the party responsible for the billing. */
+    BillToParty["Shipper"] = "shipper";
+    /** @description The recipient may be responsible for the billing of some entities, that could include the shipping cost. */
+    BillToParty["Recipient"] = "recipient";
+    /** @description A shipper may want to bill to a third-party; especially common for 3PLs and larger volume. merchants */
+    BillToParty["ThirdPartyAccount"] = "third_party_account";
+})(BillToParty || (exports.BillToParty = BillToParty = {}));
+//# sourceMappingURL=billing-to-party.js.map

package/lib/models/billing/billing-to-party.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing-to-party.js","sourceRoot":"","sources":["../../../src/models/billing/billing-to-party.ts"],"names":[],"mappings":";;;AAAA;wCACwC;AACxC,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,+FAA+F;IAC/F,kCAAmB,CAAA;IACnB,4HAA4H;IAC5H,sCAAuB,CAAA;IACvB,wHAAwH;IACxH,wDAAyC,CAAA;AAC3C,CAAC,EAPW,WAAW,2BAAX,WAAW,QAOtB"}

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

@@ -0,0 +1,6 @@
+export * from './billing-categories';
+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

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./billing-categories"), exports);
+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

@@ -0,0 +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;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/cod-payment-type.d.ts

@@ -0,0 +1,9 @@
+/** @description Specifies which payment method is permitted when Collect on Delivery (COD) is requested on a shipment */
+export declare enum CodPaymentType {
+    /** @description Any payment method is permitted */
+    Any = "any",
+    /** @description Only cash is permitted */
+    Cash = "cash",
+    /** @description Only guaranteed funds are permitted, such as a money order or cashier's check */
+    GuaranteedFunds = "guaranteed_funds"
+}

package/lib/models/cod-payment-type.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CodPaymentType = void 0;
+/** @description Specifies which payment method is permitted when Collect on Delivery (COD) is requested on a shipment */
+var CodPaymentType;
+(function (CodPaymentType) {
+    /** @description Any payment method is permitted */
+    CodPaymentType["Any"] = "any";
+    /** @description Only cash is permitted */
+    CodPaymentType["Cash"] = "cash";
+    /** @description Only guaranteed funds are permitted, such as a money order or cashier's check */
+    CodPaymentType["GuaranteedFunds"] = "guaranteed_funds";
+})(CodPaymentType || (exports.CodPaymentType = CodPaymentType = {}));
+//# sourceMappingURL=cod-payment-type.js.map

package/lib/models/cod-payment-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cod-payment-type.js","sourceRoot":"","sources":["../../src/models/cod-payment-type.ts"],"names":[],"mappings":";;;AAAA,yHAAyH;AACzH,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,mDAAmD;IACnD,6BAAW,CAAA;IACX,0CAA0C;IAC1C,+BAAa,CAAA;IACb,iGAAiG;IACjG,sDAAoC,CAAA;AACtC,CAAC,EAPW,cAAc,8BAAd,cAAc,QAOzB"}

package/lib/models/collect-on-delivery.d.ts

@@ -0,0 +1,9 @@
+import { CodPaymentType } from './cod-payment-type';
+import { Currency } from './currency';
+/** @description This model represents the option to defer payment for a shipment, otherwise known as Collect on Delivery (COD) */
+export declare class CollectOnDelivery {
+    /** @description The payment amount for Collect on Delivery (COD) */
+    payment_amount: Currency;
+    /** @description The payment method permitted for Collect on Delivery (COD) */
+    payment_type?: CodPaymentType;
+}

package/lib/models/collect-on-delivery.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectOnDelivery = void 0;
+/** @description This model represents the option to defer payment for a shipment, otherwise known as Collect on Delivery (COD) */
+class CollectOnDelivery {
+    /** @description The payment amount for Collect on Delivery (COD) */
+    payment_amount;
+    /** @description The payment method permitted for Collect on Delivery (COD) */
+    payment_type;
+}
+exports.CollectOnDelivery = CollectOnDelivery;
+//# sourceMappingURL=collect-on-delivery.js.map

package/lib/models/collect-on-delivery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collect-on-delivery.js","sourceRoot":"","sources":["../../src/models/collect-on-delivery.ts"],"names":[],"mappings":";;;AAGA,kIAAkI;AAClI,MAAa,iBAAiB;IAC5B,oEAAoE;IACpE,cAAc,CAAY;IAC1B,8EAA8E;IAC9E,YAAY,CAAkB;CAC/B;AALD,8CAKC"}

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

@@ -0,0 +1,13 @@
+/** @description Types of delivery confirmation */
+export declare enum ConfirmationTypes {
+    /** @description No confirmation is requested */
+    None = "None",
+    /** @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) */
+    Signature = "Signature",
+    /** @description A signature of an adult is required */
+    AdultSignature = "AdultSignature",
+    /** @description Only supported by FedEx. The signature of somebody at the address is required */
+    DirectSignature = "DirectSignature"
+}

package/lib/models/confirmation-types.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfirmationTypes = void 0;
+/** @description Types of delivery confirmation */
+var ConfirmationTypes;
+(function (ConfirmationTypes) {
+    /** @description No confirmation is requested */
+    ConfirmationTypes["None"] = "None";
+    /** @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) */
+    ConfirmationTypes["Signature"] = "Signature";
+    /** @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 */
+    ConfirmationTypes["DirectSignature"] = "DirectSignature";
+})(ConfirmationTypes || (exports.ConfirmationTypes = ConfirmationTypes = {}));
+//# sourceMappingURL=confirmation-types.js.map

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

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

package/lib/models/currency-schema.d.ts

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

package/lib/models/currency-schema.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CurrencySchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+exports.CurrencySchema = joi_1.default.object({
+    currency: joi_1.default.string().required(),
+    amount: joi_1.default.string().required(),
+});
+//# sourceMappingURL=currency-schema.js.map

package/lib/models/currency-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"currency-schema.js","sourceRoot":"","sources":["../../src/models/currency-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAET,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/currency.d.ts

@@ -0,0 +1,7 @@
+/** @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;
+}

package/lib/models/currency.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Currency = void 0;
+/** @description Basic structure for defining an amount of money and its currency */
+class Currency {
+    /** @description The ISO 4217 Currency Code (USD, EUR, etc) https://www.iso.org/iso-4217-currency-codes.html */
+    currency;
+    /** @description The amount */
+    amount;
+}
+exports.Currency = Currency;
+//# sourceMappingURL=currency.js.map

package/lib/models/currency.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../src/models/currency.ts"],"names":[],"mappings":";;;AAAA,oFAAoF;AACpF,MAAa,QAAQ;IACnB,+GAA+G;IAC/G,QAAQ,CAAU;IAClB,8BAA8B;IAC9B,MAAM,CAAU;CACjB;AALD,4BAKC"}

package/lib/models/customs/customs-charges-schema.d.ts

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

package/lib/models/customs/customs-charges-schema.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomsChargesSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const currency_schema_1 = require("../currency-schema");
+exports.CustomsChargesSchema = joi_1.default.object({
+    freight_charge: currency_schema_1.CurrencySchema.optional(),
+    other_charge: currency_schema_1.CurrencySchema.optional(),
+    insurance_charge: currency_schema_1.CurrencySchema.optional(),
+    discount: currency_schema_1.CurrencySchema.optional(),
+});
+//# sourceMappingURL=customs-charges-schema.js.map

package/lib/models/customs/customs-charges-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customs-charges-schema.js","sourceRoot":"","sources":["../../../src/models/customs/customs-charges-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wDAAoD;AAEvC,QAAA,oBAAoB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC7C,cAAc,EAAE,gCAAc,CAAC,QAAQ,EAAE;IACzC,YAAY,EAAE,gCAAc,CAAC,QAAQ,EAAE;IACvC,gBAAgB,EAAE,gCAAc,CAAC,QAAQ,EAAE;IAC3C,QAAQ,EAAE,gCAAc,CAAC,QAAQ,EAAE;CACpC,CAAC,CAAC"}

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

@@ -0,0 +1,19 @@
+import { Currency } from '../currency';
+import { EstimatedImportCharges } from './estimated-import-charges';
+/** @description This model represents the charges related with customs. */
+export declare class CustomsCharges {
+    /** @description Freight charge for international shipments. */
+    freight_charge?: Currency;
+    /** @description Other charge for international shipments. */
+    other_charge?: Currency;
+    /** @description : Description for other charge for international shipments.*/
+    other_charge_description?: string;
+    /** @description Insurance charge for international shipments. */
+    insurance_charge?: Currency;
+    /** @description Discount for international shipments. */
+    discount?: Currency;
+    /**@description:   Estimated charges related to importing goods, such as customs duties, taxes, and other import-related fees. Depending on carrier, if provided they will be displayed on the Commercial Invoice.  */
+    estimated_import_charges?: EstimatedImportCharges;
+    /** @description : The invoice number to be used in the customs.*/
+    invoice_number?: string;
+}

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomsCharges = void 0;
+/** @description This model represents the charges related with customs. */
+class CustomsCharges {
+    /** @description Freight charge for international shipments. */
+    freight_charge;
+    /** @description Other charge for international shipments. */
+    other_charge;
+    /** @description : Description for other charge for international shipments.*/
+    other_charge_description;
+    /** @description Insurance charge for international shipments. */
+    insurance_charge;
+    /** @description Discount for international shipments. */
+    discount;
+    /**@description:   Estimated charges related to importing goods, such as customs duties, taxes, and other import-related fees. Depending on carrier, if provided they will be displayed on the Commercial Invoice.  */
+    estimated_import_charges;
+    /** @description : The invoice number to be used in the customs.*/
+    invoice_number;
+}
+exports.CustomsCharges = CustomsCharges;
+//# sourceMappingURL=customs-charges.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customs-charges.js","sourceRoot":"","sources":["../../../src/models/customs/customs-charges.ts"],"names":[],"mappings":";;;AAGA,2EAA2E;AAC3E,MAAa,cAAc;IACzB,+DAA+D;IAC/D,cAAc,CAAY;IAC1B,6DAA6D;IAC7D,YAAY,CAAY;IACxB,8EAA8E;IAC9E,wBAAwB,CAAU;IAClC,iEAAiE;IACjE,gBAAgB,CAAY;IAC5B,yDAAyD;IACzD,QAAQ,CAAY;IACpB,sNAAsN;IACtN,wBAAwB,CAA0B;IAClD,kEAAkE;IAClE,cAAc,CAAU;CACzB;AAfD,wCAeC"}

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

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

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomsContentTypesSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const customs_content_types_1 = require("./customs-content-types");
+exports.CustomsContentTypesSchema = joi_1.default.string().valid(...Object.values(customs_content_types_1.CustomsContentTypes));
+//# sourceMappingURL=customs-content-types-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customs-content-types-schema.js","sourceRoot":"","sources":["../../../src/models/customs/customs-content-types-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,mEAA8D;AAEjD,QAAA,yBAAyB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,2CAAmB,CAAC,CAAC,CAAC"}

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

@@ -0,0 +1,15 @@
+/** @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 Sample goods that are being shipped */
+    Sample = "sample",
+    /** @description Items that are being returned */
+    ReturnedGoods = "returned_goods",
+    /** @description   What other means in case of the shipment*/
+    Other = "other"
+}

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

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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 Sample goods that are being shipped */
+    CustomsContentTypes["Sample"] = "sample";
+    /** @description Items that are being returned */
+    CustomsContentTypes["ReturnedGoods"] = "returned_goods";
+    /** @description   What other means in case of the shipment*/
+    CustomsContentTypes["Other"] = "other";
+})(CustomsContentTypes || (exports.CustomsContentTypes = CustomsContentTypes = {}));
+//# sourceMappingURL=customs-content-types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customs-content-types.js","sourceRoot":"","sources":["../../../src/models/customs/customs-content-types.ts"],"names":[],"mappings":";;;AAAA,4DAA4D;AAC5D,IAAY,mBAaX;AAbD,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;IAChC,6DAA6D;IAC7D,sCAAe,CAAA;AACjB,CAAC,EAbW,mBAAmB,mCAAnB,mBAAmB,QAa9B"}

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

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

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

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomsItemSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const currency_schema_1 = require("../currency-schema");
+const weight_details_schema_1 = require("../units/weight-details-schema");
+exports.CustomsItemSchema = joi_1.default.object({
+    description: joi_1.default.string().optional(),
+    quantity: joi_1.default.number().optional(),
+    value: currency_schema_1.CurrencySchema.optional(),
+    country_of_origin: joi_1.default.string().optional(),
+    harmonized_tariff_code: joi_1.default.string().optional(),
+    sku: joi_1.default.string().optional(),
+    sku_description: joi_1.default.string().optional(),
+    item_weight: weight_details_schema_1.WeightDetailsSchema.optional(),
+    product_url: joi_1.default.string().optional(),
+    vat_rate: joi_1.default.number().optional(),
+    mid_code: joi_1.default.string().optional(),
+});
+//# sourceMappingURL=customs-item-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customs-item-schema.js","sourceRoot":"","sources":["../../../src/models/customs/customs-item-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wDAAoD;AACpD,0EAAqE;AAExD,QAAA,iBAAiB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC1C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,KAAK,EAAE,gCAAc,CAAC,QAAQ,EAAE;IAChC,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,sBAAsB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/C,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,WAAW,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC3C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC"}

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

@@ -0,0 +1,29 @@
+import { Currency } from '../currency';
+import { WeightDetails } from '../units';
+/** @deprecated This object has been deprecated, please use packages.products[] instead */
+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;
+    /** @description A link to the item being shipped on the seller's website, used by customs officials to visually compare the item in the package to the available photo on the website. */
+    product_url?: string;
+    /** @description The VAT rate applicable to the item being shipped, expressed as a decimal value between 0 and 1. */
+    vat_rate?: number;
+    /** @description The Manufacturer Identification Code (MID). It is ussed as an alternative to the full name and address of a manufacturer, shipper or exporter and is always required for U.S. formal customs entries. */
+    mid_code?: string;
+    /** @description Additional details for product. */
+    [key: string]: any;
+}

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

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomsItem = void 0;
+/** @deprecated This object has been deprecated, please use packages.products[] instead */
+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;
+    /** @description The user specified count of items in this declaration. This value should be 1 or greater */
+    quantity;
+    /** @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;
+    /** @description The user specified declared country of origin of this customs item */
+    country_of_origin;
+    /** @description The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information */
+    harmonized_tariff_code;
+    /** @description The user specified SKU of this customs item. This field is completely free form. */
+    sku;
+    /** @description The user specified SKU description of this customs item. This field is completely free form. */
+    sku_description;
+    /** @description Detailed information about the weight of this item */
+    item_weight;
+    /** @description A link to the item being shipped on the seller's website, used by customs officials to visually compare the item in the package to the available photo on the website. */
+    product_url;
+    /** @description The VAT rate applicable to the item being shipped, expressed as a decimal value between 0 and 1. */
+    vat_rate;
+    /** @description The Manufacturer Identification Code (MID). It is ussed as an alternative to the full name and address of a manufacturer, shipper or exporter and is always required for U.S. formal customs entries. */
+    mid_code;
+}
+exports.CustomsItem = CustomsItem;
+//# sourceMappingURL=customs-item.js.map