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

package/lib/models/pickup/shipment-identifier-schema.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShipmentIdentifierSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const identifier_schema_1 = require("../identifier-schema");
+exports.ShipmentIdentifierSchema = joi_1.default.object({
+    tracking_number: joi_1.default.string().optional().empty(),
+    alternate_identifiers: joi_1.default.array().optional().items(identifier_schema_1.IdentifierSchema),
+});
+//# sourceMappingURL=shipment-identifier-schema.js.map

package/lib/models/pickup/shipment-identifier-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipment-identifier-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/shipment-identifier-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,4DAAwD;AAE3C,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,qBAAqB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,oCAAgB,CAAC;CACtE,CAAC,CAAC"}

package/lib/models/pickup/shipment-identifier.d.ts

@@ -0,0 +1,8 @@
+import { Identifier } from '../identifier';
+/** @description Identifier object for shiments */
+export declare class ShipmentIdentifier {
+    /** @description The carrier tracking number for this shipment */
+    tracking_number?: string;
+    /** @description A list of alternate identifiers that can be used to identify a shipment */
+    alternate_identifiers?: Identifier[];
+}

package/lib/models/pickup/shipment-identifier.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShipmentIdentifier = void 0;
+/** @description Identifier object for shiments */
+class ShipmentIdentifier {
+    /** @description The carrier tracking number for this shipment */
+    tracking_number;
+    /** @description A list of alternate identifiers that can be used to identify a shipment */
+    alternate_identifiers;
+}
+exports.ShipmentIdentifier = ShipmentIdentifier;
+//# sourceMappingURL=shipment-identifier.js.map

package/lib/models/pickup/shipment-identifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipment-identifier.js","sourceRoot":"","sources":["../../../src/models/pickup/shipment-identifier.ts"],"names":[],"mappings":";;;AAEA,kDAAkD;AAClD,MAAa,kBAAkB;IAC7B,iEAAiE;IACjE,eAAe,CAAU;IACzB,2FAA2F;IAC3F,qBAAqB,CAAgB;CACtC;AALD,gDAKC"}

package/lib/models/pickup/shipped-package-schema.d.ts

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

package/lib/models/pickup/shipped-package-schema.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShippedPackageSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const identifier_schema_1 = require("../identifier-schema");
+const units_1 = require("../units");
+const currency_schema_1 = require("../currency-schema");
+const dimension_details_schema_1 = require("../units/dimension-details-schema");
+const weight_details_schema_1 = require("../units/weight-details-schema");
+const label_message_schema_1 = require("../labels/label-message-schema");
+const customs_schema_1 = require("../customs/customs-schema");
+exports.ShippedPackageSchema = joi_1.default.object({
+    tracking_number: joi_1.default.string().optional(),
+    tracking_url: joi_1.default.string().optional(),
+    alternative_identifiers: joi_1.default.array().items(identifier_schema_1.IdentifierSchema).optional(),
+    dimension_details: dimension_details_schema_1.DimensionDetailsSchema.optional(),
+    weight_details: weight_details_schema_1.WeightDetailsSchema.optional(),
+    package_code: joi_1.default.string().optional(),
+    weight: joi_1.default.number().optional(),
+    dimensions: units_1.DimensionsSchema.optional(),
+    insured_value: currency_schema_1.CurrencySchema.required(),
+    label_messages: label_message_schema_1.LabelMessageSchema.optional(),
+    customs: customs_schema_1.CustomsSchema.optional(),
+    products: joi_1.default.array().items(identifier_schema_1.IdentifierSchema).optional(),
+});
+//# sourceMappingURL=shipped-package-schema.js.map

package/lib/models/pickup/shipped-package-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipped-package-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-package-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,4DAAwD;AACxD,oCAA4C;AAC5C,wDAAoD;AACpD,gFAA2E;AAC3E,0EAAqE;AACrE,yEAAoE;AACpE,8DAA0D;AAE7C,QAAA,oBAAoB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC7C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,uBAAuB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,oCAAgB,CAAC,CAAC,QAAQ,EAAE;IACvE,iBAAiB,EAAE,iDAAsB,CAAC,QAAQ,EAAE;IACpD,cAAc,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC9C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,wBAAgB,CAAC,QAAQ,EAAE;IACvC,aAAa,EAAE,gCAAc,CAAC,QAAQ,EAAE;IACxC,cAAc,EAAE,yCAAkB,CAAC,QAAQ,EAAE;IAC7C,OAAO,EAAE,8BAAa,CAAC,QAAQ,EAAE;IACjC,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,oCAAgB,CAAC,CAAC,QAAQ,EAAE;CACzD,CAAC,CAAC"}

package/lib/models/pickup/shipped-package.d.ts

@@ -0,0 +1,35 @@
+import { Identifier } from '../identifier';
+import { DimensionDetails } from '../units/dimension-details';
+import { WeightDetails } from '../units/weight-details';
+import { Dimensions } from '../units/dimensions';
+import { Currency } from '../currency';
+import { LabelMessage } from '../labels/label-message';
+import { Customs } from '../customs';
+import { ShippedProducts } from './shipped-products';
+/** @description Basic structure for a package that has been shipped */
+export declare class ShippedPackage {
+    /** @description The carrier tracking number associated with this package */
+    tracking_number?: string;
+    /** @description The carrier tracking URL associated with this package */
+    tracking_url?: string;
+    /** @description Alternative identifiers associated with this package */
+    alternative_identifiers?: Identifier[];
+    /** @description Details about the dimensions of the package */
+    dimension_details?: DimensionDetails;
+    /** @description Details about the weight of the package */
+    weight_details?: WeightDetails;
+    /** @description The code associated with the package type */
+    package_code?: string;
+    /** @deprectated Please use the weight_details property */
+    weight?: number;
+    /** @deprectated Please use the dimension_details property */
+    dimensions?: Dimensions;
+    /** @description The insured value of this package. */
+    insured_value: Currency;
+    /** @description The message the seller requested to have on their label */
+    label_messages?: LabelMessage;
+    /** @description Basic structure for a customs declaration (Only available on international shipments) */
+    customs?: Customs;
+    /** @description List of products associated with this package. */
+    products?: ShippedProducts[];
+}

package/lib/models/pickup/shipped-package.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShippedPackage = void 0;
+/** @description Basic structure for a package that has been shipped */
+class ShippedPackage {
+    /** @description The carrier tracking number associated with this package */
+    tracking_number;
+    /** @description The carrier tracking URL associated with this package */
+    tracking_url;
+    /** @description Alternative identifiers associated with this package */
+    alternative_identifiers;
+    /** @description Details about the dimensions of the package */
+    dimension_details;
+    /** @description Details about the weight of the package */
+    weight_details;
+    /** @description The code associated with the package type */
+    package_code;
+    /** @deprectated Please use the weight_details property */
+    weight;
+    /** @deprectated Please use the dimension_details property */
+    dimensions;
+    /** @description The insured value of this package. */
+    insured_value;
+    /** @description The message the seller requested to have on their label */
+    label_messages;
+    /** @description Basic structure for a customs declaration (Only available on international shipments) */
+    customs;
+    /** @description List of products associated with this package. */
+    products;
+}
+exports.ShippedPackage = ShippedPackage;
+//# sourceMappingURL=shipped-package.js.map

package/lib/models/pickup/shipped-package.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipped-package.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-package.ts"],"names":[],"mappings":";;;AASA,uEAAuE;AACvE,MAAa,cAAc;IACzB,4EAA4E;IAC5E,eAAe,CAAU;IACzB,yEAAyE;IACzE,YAAY,CAAU;IACtB,wEAAwE;IACxE,uBAAuB,CAAgB;IACvC,+DAA+D;IAC/D,iBAAiB,CAAoB;IACrC,2DAA2D;IAC3D,cAAc,CAAiB;IAC/B,6DAA6D;IAC7D,YAAY,CAAU;IACtB,0DAA0D;IAC1D,MAAM,CAAU;IAChB,6DAA6D;IAC7D,UAAU,CAAc;IACxB,sDAAsD;IACtD,aAAa,CAAY;IACzB,2EAA2E;IAC3E,cAAc,CAAgB;IAC9B,yGAAyG;IACzG,OAAO,CAAW;IAClB,kEAAkE;IAClE,QAAQ,CAAqB;CAC9B;AAzBD,wCAyBC"}

package/lib/models/pickup/shipped-products-schema.d.ts

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

package/lib/models/pickup/shipped-products-schema.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShippedProductsSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const connect_carrier_api_1 = require("@shipengine/connect-carrier-api");
+const weight_details_schema_1 = require("../units/weight-details-schema");
+exports.ShippedProductsSchema = joi_1.default.object({
+    description: joi_1.default.string().optional(),
+    quantity: joi_1.default.number().optional(),
+    value: connect_carrier_api_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(),
+    dangerous_goods: joi_1.default.object().optional(),
+});
+//# sourceMappingURL=shipped-products-schema.js.map

package/lib/models/pickup/shipped-products-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipped-products-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-products-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,yEAAiE;AACjE,0EAAqE;AAExD,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,KAAK,EAAE,oCAAc,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;IACjC,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC"}

package/lib/models/pickup/shipped-products.d.ts

@@ -0,0 +1,31 @@
+import { Currency, WeightDetails } from '@shipengine/connect-carrier-api';
+import { DangerousGoods } from '../dangerous-good/dangerous-goods';
+/** @description Basic structure for a product from a shipped shipment*/
+export declare class ShippedProducts {
+    /** @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 List of dangerous goods model associated with this package passed to the carrier. */
+    dangerous_goods?: DangerousGoods[];
+    /** @description Additional details for product. */
+    [key: string]: any;
+}

package/lib/models/pickup/shipped-products.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShippedProducts = void 0;
+/** @description Basic structure for a product from a shipped shipment*/
+class ShippedProducts {
+    /** @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;
+    /** @description List of dangerous goods model associated with this package passed to the carrier. */
+    dangerous_goods;
+}
+exports.ShippedProducts = ShippedProducts;
+//# sourceMappingURL=shipped-products.js.map

package/lib/models/pickup/shipped-products.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipped-products.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-products.ts"],"names":[],"mappings":";;;AAGA,wEAAwE;AACxE,MAAa,eAAe;IAC1B,mJAAmJ;IACnJ,WAAW,CAAU;IACrB,4GAA4G;IAC5G,QAAQ,CAAU;IAClB,mKAAmK;IACnK,KAAK,CAAY;IACjB,sFAAsF;IACtF,iBAAiB,CAAU;IAC3B,8GAA8G;IAC9G,sBAAsB,CAAU;IAChC,oGAAoG;IACpG,GAAG,CAAU;IACb,gHAAgH;IAChH,eAAe,CAAU;IACzB,sEAAsE;IACtE,WAAW,CAAiB;IAC5B,0LAA0L;IAC1L,WAAW,CAAU;IACrB,oHAAoH;IACpH,QAAQ,CAAU;IAClB,yNAAyN;IACzN,QAAQ,CAAU;IAClB,qGAAqG;IACrG,eAAe,CAAoB;CAGpC;AA3BD,0CA2BC"}

package/lib/models/pickup/shipped-shipment.d.ts

@@ -0,0 +1,27 @@
+import { Label } from '../manifests/label';
+import { ShipTo } from '../addresses/ship-to';
+import { AdvancedOptions } from '../advanced-options';
+import { Identifier } from '../identifier';
+import { ShippedPackage } from './shipped-package';
+import { PudoLocation } from '../../models';
+/** @description Basic structure for a shipment that has been shipped */
+export declare class ShippedShipment extends Label {
+    /** @description The address that a shipment will be delivered to */
+    ship_to?: ShipTo;
+    /** @description Non-tracking alternative ids associated with this shipment */
+    alternative_identifiers?: Identifier[];
+    /** @description The service code used for this shipment */
+    service_code?: string;
+    /** @description The list of packages associated with this shipment */
+    packages?: ShippedPackage[];
+    /** @description Advanced shipping options (Contains Alcohol, Non Machinable, etc) */
+    advanced_options?: AdvancedOptions;
+    /** @description Add pick-up location detail*/
+    pickup_location?: PudoLocation;
+    /** @description Add drop-off location detail*/
+    dropoff_location?: PudoLocation;
+    /** @description User specified free form string to identify shipment in their own system */
+    reference?: string;
+}
+export declare class PickupShipment extends ShippedShipment {
+}

package/lib/models/pickup/shipped-shipment.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PickupShipment = exports.ShippedShipment = void 0;
+const label_1 = require("../manifests/label");
+/** @description Basic structure for a shipment that has been shipped */
+class ShippedShipment extends label_1.Label {
+    /** @description The address that a shipment will be delivered to */
+    ship_to;
+    /** @description Non-tracking alternative ids associated with this shipment */
+    alternative_identifiers;
+    /** @description The service code used for this shipment */
+    service_code;
+    /** @description The list of packages associated with this shipment */
+    packages;
+    /** @description Advanced shipping options (Contains Alcohol, Non Machinable, etc) */
+    advanced_options;
+    /** @description Add pick-up location detail*/
+    pickup_location;
+    /** @description Add drop-off location detail*/
+    dropoff_location;
+    /** @description User specified free form string to identify shipment in their own system */
+    reference;
+}
+exports.ShippedShipment = ShippedShipment;
+class PickupShipment extends ShippedShipment {
+}
+exports.PickupShipment = PickupShipment;
+//# sourceMappingURL=shipped-shipment.js.map

package/lib/models/pickup/shipped-shipment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipped-shipment.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-shipment.ts"],"names":[],"mappings":";;;AAAA,8CAA2C;AAO3C,wEAAwE;AACxE,MAAa,eAAgB,SAAQ,aAAK;IACxC,oEAAoE;IACpE,OAAO,CAAU;IACjB,8EAA8E;IAC9E,uBAAuB,CAAgB;IACvC,2DAA2D;IAC3D,YAAY,CAAU;IACtB,sEAAsE;IACtE,QAAQ,CAAoB;IAC5B,qFAAqF;IACrF,gBAAgB,CAAmB;IACnC,8CAA8C;IAC9C,eAAe,CAAgB;IAC/B,+CAA+C;IAC/C,gBAAgB,CAAgB;IAChC,4FAA4F;IAC5F,SAAS,CAAU;CACpB;AAjBD,0CAiBC;AAED,MAAa,cAAe,SAAQ,eAAe;CAAG;AAAtD,wCAAsD"}

package/lib/models/products.d.ts

@@ -0,0 +1,35 @@
+import { WeightDetails } from './units/weight-details';
+import { Currency } from './currency';
+import { DangerousGoods } from './dangerous-good/dangerous-goods';
+import { UnitOfMeasureTypes } from './customs/unit-of-measure-types';
+/** @description Basic structure for a product */
+export declare class Products {
+    /** @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 unit of measure of this customs item */
+    unit_of_measure?: UnitOfMeasureTypes;
+    /** @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 List of dangerous goods model associated with this package passed to the carrier. */
+    dangerous_goods?: DangerousGoods[];
+    /** @description Additional details for product. */
+    [key: string]: any;
+}

package/lib/models/products.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Products = void 0;
+/** @description Basic structure for a product */
+class Products {
+    /** @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 unit of measure of this customs item */
+    unit_of_measure;
+    /** @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;
+    /** @description List of dangerous goods model associated with this package passed to the carrier. */
+    dangerous_goods;
+}
+exports.Products = Products;
+//# sourceMappingURL=products.js.map

package/lib/models/products.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/models/products.ts"],"names":[],"mappings":";;;AAKA,iDAAiD;AACjD,MAAa,QAAQ;IACnB,mJAAmJ;IACnJ,WAAW,CAAU;IACrB,4GAA4G;IAC5G,QAAQ,CAAU;IAClB,mKAAmK;IACnK,KAAK,CAAY;IACjB,sFAAsF;IACtF,iBAAiB,CAAU;IAC3B,8GAA8G;IAC9G,sBAAsB,CAAU;IAChC,2EAA2E;IAC3E,eAAe,CAAsB;IACrC,oGAAoG;IACpG,GAAG,CAAU;IACb,gHAAgH;IAChH,eAAe,CAAU;IACzB,sEAAsE;IACtE,WAAW,CAAiB;IAC5B,0LAA0L;IAC1L,WAAW,CAAU;IACrB,oHAAoH;IACpH,QAAQ,CAAU;IAClB,yNAAyN;IACzN,QAAQ,CAAU;IAClB,qGAAqG;IACrG,eAAe,CAAoB;CAGpC;AA7BD,4BA6BC"}

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

@@ -0,0 +1,2 @@
+export * from './rate';
+export * from './rate-schema';

package/lib/models/rates/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./rate"), exports);
+tslib_1.__exportStar(require("./rate-schema"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/rates/index.ts"],"names":[],"mappings":";;;AAAA,iDAAuB;AACvB,wDAA8B"}

package/lib/models/rates/rate-schema.d.ts

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

package/lib/models/rates/rate-schema.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const billing_line_item_schema_1 = require("../billing/billing-line-item-schema");
+const time_window_schema_1 = require("../time-window-schema");
+exports.RateSchema = joi_1.default.object({
+    service_code: joi_1.default.string().optional().empty(),
+    ship_datetime: joi_1.default.string().optional().empty().isoDate(),
+    estimated_delivery_datetime: joi_1.default.string().optional().empty().isoDate(),
+    billing_line_items: joi_1.default.array().optional().items(billing_line_item_schema_1.BillingLineItemSchema),
+    error_messages: joi_1.default.array().optional().items(joi_1.default.string()),
+    warning_messages: joi_1.default.array().optional().items(joi_1.default.string()),
+    negotiated_rate: joi_1.default.boolean().optional(),
+    carrier_pickup_window: time_window_schema_1.TimeWindowSchema.optional(),
+    delivery_window: time_window_schema_1.TimeWindowSchema.optional(),
+    carrier_rate_id: joi_1.default.string().optional().empty(),
+    expiration_datetime: joi_1.default.string().optional().empty().isoDate(),
+    estimated_delivery_text: joi_1.default.string().optional().empty(),
+    package_type: joi_1.default.string().optional().empty(),
+    zone: joi_1.default.string().optional().empty(),
+    guaranteed_delivery_days: joi_1.default.number().optional().empty(),
+});
+//# sourceMappingURL=rate-schema.js.map

package/lib/models/rates/rate-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-schema.js","sourceRoot":"","sources":["../../../src/models/rates/rate-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,kFAA4E;AAC5E,8DAAyD;AAE5C,QAAA,UAAU,GAAG,aAAG,CAAC,MAAM,CAAC;IACnC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACxD,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACtE,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gDAAqB,CAAC;IACvE,cAAc,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC;IAC1D,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC;IAC5D,eAAe,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACzC,qBAAqB,EAAE,qCAAgB,CAAC,QAAQ,EAAE;IAClD,eAAe,EAAE,qCAAgB,CAAC,QAAQ,EAAE;IAC5C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC9D,uBAAuB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACxD,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,wBAAwB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CAC1D,CAAC,CAAC"}

package/lib/models/rates/rate.d.ts

@@ -0,0 +1,38 @@
+import { BillingLineItem } from '../billing/billing-line-item';
+import { TimeWindow } from '../time-window';
+import { CarrierWeight } from '../units/carrier-weight';
+/** @description Basic structure for a rate */
+export declare class Rate {
+    /** @description The service code uniquely identifies a shipping service that you offer. Which service codes can be passed to you will be configured in ShipEngine. If this field is missing, the rate will be discarded. */
+    service_code?: string;
+    /** @description ISO 8601 formatted date for shipment */
+    ship_datetime?: string;
+    /** @description ISO 8601 formatted estimated delivery date */
+    estimated_delivery_datetime?: string;
+    /** @description List of charge details for a rate */
+    billing_line_items?: BillingLineItem[];
+    /** @description Any error messages that resulted while trying to get the rate */
+    error_messages?: string[];
+    /** @description Any warning messages that resulted while trying to get the rate */
+    warning_messages?: string[];
+    /** @description Is the rate pre-negotiated? */
+    negotiated_rate?: boolean;
+    /** @description The carrier pickup window is the time designated when the carrier will pickup your package from the initial location */
+    carrier_pickup_window?: TimeWindow;
+    /** @description The delivery window is the time designated when the carrier will drop off the package to the recipient */
+    delivery_window?: TimeWindow;
+    /** @description Unique identifier for the carrier rate */
+    carrier_rate_id?: string;
+    /** @description DateTime after which the rate will no longer be accepted. ISO 8601 format, with local offset. Example: 2021-08-20T14:38:36.859237-05:00 */
+    expiration_datetime?: string;
+    /** @description Estimated delivery text. It could be any text, a number, a date, etc. */
+    estimated_delivery_text?: string;
+    /** @description The Package type of this rate */
+    package_type?: string;
+    /** @description The zone this rate is for */
+    zone?: string;
+    /** @description Guaranteed delivery days. The number of days it will take for the package to be delivered */
+    guaranteed_delivery_days?: number;
+    /** @description The actual weight value assessed by the carrier based on the ingredients provided, it may be used for customer billing purposes. */
+    carrier_weight?: CarrierWeight;
+}

package/lib/models/rates/rate.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Rate = void 0;
+/** @description Basic structure for a rate */
+class Rate {
+    /** @description The service code uniquely identifies a shipping service that you offer. Which service codes can be passed to you will be configured in ShipEngine. If this field is missing, the rate will be discarded. */
+    service_code;
+    /** @description ISO 8601 formatted date for shipment */
+    ship_datetime;
+    /** @description ISO 8601 formatted estimated delivery date */
+    estimated_delivery_datetime;
+    /** @description List of charge details for a rate */
+    billing_line_items;
+    /** @description Any error messages that resulted while trying to get the rate */
+    error_messages;
+    /** @description Any warning messages that resulted while trying to get the rate */
+    warning_messages;
+    /** @description Is the rate pre-negotiated? */
+    negotiated_rate;
+    /** @description The carrier pickup window is the time designated when the carrier will pickup your package from the initial location */
+    carrier_pickup_window;
+    /** @description The delivery window is the time designated when the carrier will drop off the package to the recipient */
+    delivery_window;
+    /** @description Unique identifier for the carrier rate */
+    carrier_rate_id;
+    /** @description DateTime after which the rate will no longer be accepted. ISO 8601 format, with local offset. Example: 2021-08-20T14:38:36.859237-05:00 */
+    expiration_datetime;
+    /** @description Estimated delivery text. It could be any text, a number, a date, etc. */
+    estimated_delivery_text;
+    /** @description The Package type of this rate */
+    package_type;
+    /** @description The zone this rate is for */
+    zone;
+    /** @description Guaranteed delivery days. The number of days it will take for the package to be delivered */
+    guaranteed_delivery_days;
+    /** @description The actual weight value assessed by the carrier based on the ingredients provided, it may be used for customer billing purposes. */
+    carrier_weight;
+}
+exports.Rate = Rate;
+//# sourceMappingURL=rate.js.map

package/lib/models/rates/rate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate.js","sourceRoot":"","sources":["../../../src/models/rates/rate.ts"],"names":[],"mappings":";;;AAIA,8CAA8C;AAC9C,MAAa,IAAI;IACf,4NAA4N;IAC5N,YAAY,CAAU;IACtB,wDAAwD;IACxD,aAAa,CAAU;IACvB,8DAA8D;IAC9D,2BAA2B,CAAU;IACrC,qDAAqD;IACrD,kBAAkB,CAAqB;IACvC,iFAAiF;IACjF,cAAc,CAAY;IAC1B,mFAAmF;IACnF,gBAAgB,CAAY;IAC5B,+CAA+C;IAC/C,eAAe,CAAW;IAC1B,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0HAA0H;IAC1H,eAAe,CAAc;IAC7B,0DAA0D;IAC1D,eAAe,CAAU;IACzB,2JAA2J;IAC3J,mBAAmB,CAAU;IAC7B,yFAAyF;IACzF,uBAAuB,CAAU;IACjC,iDAAiD;IACjD,YAAY,CAAU;IACtB,6CAA6C;IAC7C,IAAI,CAAU;IACd,6GAA6G;IAC7G,wBAAwB,CAAU;IAClC,oJAAoJ;IACpJ,cAAc,CAAiB;CAChC;AAjCD,oBAiCC"}

package/lib/models/registration/credentials-schema.d.ts

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

package/lib/models/registration/credentials-schema.js

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

package/lib/models/registration/credentials-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credentials-schema.js","sourceRoot":"","sources":["../../../src/models/registration/credentials-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAET,QAAA,iBAAiB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC1C,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/registration/credentials.d.ts

@@ -0,0 +1,7 @@
+/** @description Basic structure for credentials */
+export declare class Credentials {
+    /** @description The username, used as the unique identifier for the account */
+    username: string;
+    /** @description The password that will be sent in future requests */
+    password: string;
+}

package/lib/models/registration/credentials.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Credentials = void 0;
+/** @description Basic structure for credentials */
+class Credentials {
+    /** @description The username, used as the unique identifier for the account */
+    username;
+    /** @description The password that will be sent in future requests */
+    password;
+}
+exports.Credentials = Credentials;
+//# sourceMappingURL=credentials.js.map

package/lib/models/registration/credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credentials.js","sourceRoot":"","sources":["../../../src/models/registration/credentials.ts"],"names":[],"mappings":";;;AAAA,mDAAmD;AACnD,MAAa,WAAW;IACtB,+EAA+E;IAC/E,QAAQ,CAAU;IAClB,qEAAqE;IACrE,QAAQ,CAAU;CACnB;AALD,kCAKC"}

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

@@ -0,0 +1,2 @@
+export * from './credentials';
+export * from './credentials-schema';

package/lib/models/registration/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./credentials"), exports);
+tslib_1.__exportStar(require("./credentials-schema"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/registration/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B;AAC9B,+DAAqC"}

package/lib/models/relay-points/index.d.ts

@@ -0,0 +1,8 @@
+export * from './opening-times-schema';
+export * from './opening-times';
+export * from './relay-point-address-schema';
+export * from './relay-point-address';
+export * from './relay-point-details-schema';
+export * from './relay-point-details';
+export * from './relay-point-schema';
+export * from './relay-point';

package/lib/models/relay-points/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./opening-times-schema"), exports);
+tslib_1.__exportStar(require("./opening-times"), exports);
+tslib_1.__exportStar(require("./relay-point-address-schema"), exports);
+tslib_1.__exportStar(require("./relay-point-address"), exports);
+tslib_1.__exportStar(require("./relay-point-details-schema"), exports);
+tslib_1.__exportStar(require("./relay-point-details"), exports);
+tslib_1.__exportStar(require("./relay-point-schema"), exports);
+tslib_1.__exportStar(require("./relay-point"), exports);
+//# sourceMappingURL=index.js.map