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

package/lib/models/native-rating/implementation-type.d.ts

@@ -0,0 +1,30 @@
+import type { GetRatesRequest, Rate } from '@shipengine/connect-carrier-api';
+import type { RatingContext } from './rating-context';
+/** A rate request shipment with its corresponding id */
+export interface ShipmentAndId {
+    /** rate_request_identifier for the rate request */
+    id: string;
+    /** Shipment for the rate request */
+    shipment: GetRatesRequest;
+}
+/** Rate results with its corresponding rate request id */
+export interface RateResultsAndId {
+    /** rate_request_identifier for the corresponding rate request */
+    id: string;
+    /** Error, if any */
+    error?: unknown;
+    /** Rates for a given rate request */
+    rates: Rate[];
+}
+/** Implementation of a carrier */
+export interface RatingCarrier {
+    /** Rate shipments
+     * @param context Native Rating context that can be used by the implementation to interact with the underlying service
+     * @param shipment Shipments that should be rated
+     * @returns List of rates for the given shipments
+     */
+    rateShipments: (context: RatingContext, shipment: ShipmentAndId[]) => Promise<RateResultsAndId[]>;
+}
+/** Signify a validation error from the carrier */
+export declare class CarrierValidationError extends Error {
+}

package/lib/models/native-rating/implementation-type.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CarrierValidationError = void 0;
+/** Signify a validation error from the carrier */
+class CarrierValidationError extends Error {
+}
+exports.CarrierValidationError = CarrierValidationError;
+//# sourceMappingURL=implementation-type.js.map

package/lib/models/native-rating/implementation-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"implementation-type.js","sourceRoot":"","sources":["../../../src/models/native-rating/implementation-type.ts"],"names":[],"mappings":";;;AA+BA,kDAAkD;AAClD,MAAa,sBAAuB,SAAQ,KAAK;CAAG;AAApD,wDAAoD"}

package/lib/models/native-rating/index.d.ts

@@ -0,0 +1,7 @@
+export * from './context-results';
+export * from './get-rates';
+export * from './get-variables';
+export * from './get-zone';
+export * from './implementation-type';
+export * from './numeric-currency';
+export * from './rating-context';

package/lib/models/native-rating/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./context-results"), exports);
+tslib_1.__exportStar(require("./get-rates"), exports);
+tslib_1.__exportStar(require("./get-variables"), exports);
+tslib_1.__exportStar(require("./get-zone"), exports);
+tslib_1.__exportStar(require("./implementation-type"), exports);
+tslib_1.__exportStar(require("./numeric-currency"), exports);
+tslib_1.__exportStar(require("./rating-context"), exports);
+//# sourceMappingURL=index.js.map

package/lib/models/native-rating/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/native-rating/index.ts"],"names":[],"mappings":";;;AAAA,4DAAkC;AAClC,sDAA4B;AAC5B,0DAAgC;AAChC,qDAA2B;AAC3B,gEAAsC;AACtC,6DAAmC;AACnC,2DAAiC"}

package/lib/models/native-rating/numeric-currency.d.ts

@@ -0,0 +1,5 @@
+/** NumericCurrency so that we don't have to convert from the string Currency all over the place */
+export interface NumericCurrency {
+    currency: string;
+    amount: number | undefined;
+}

package/lib/models/native-rating/numeric-currency.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=numeric-currency.js.map

package/lib/models/native-rating/numeric-currency.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"numeric-currency.js","sourceRoot":"","sources":["../../../src/models/native-rating/numeric-currency.ts"],"names":[],"mappings":""}

package/lib/models/native-rating/rating-context.d.ts

@@ -0,0 +1,15 @@
+import { Logger } from 'winston';
+import { GetVariables } from './get-variables';
+import { GetRates } from './get-rates';
+import { GetZone } from './get-zone';
+/** Rates request context */
+export interface RatingContext {
+    /** Function to get rates for given keys */
+    getRates: GetRates;
+    /** Function to get variables for given keys */
+    getVariables: GetVariables;
+    /** Function to get zone for given keys */
+    getZone: GetZone;
+    /** Logger that implementers can use */
+    log: Logger;
+}

package/lib/models/native-rating/rating-context.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=rating-context.js.map

package/lib/models/native-rating/rating-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rating-context.js","sourceRoot":"","sources":["../../../src/models/native-rating/rating-context.ts"],"names":[],"mappings":""}

package/lib/models/package.d.ts

@@ -0,0 +1,28 @@
+import { DimensionDetails } from './units/dimension-details';
+import { WeightDetails } from './units/weight-details';
+import { Currency } from './currency';
+import { LabelMessage } from './labels/label-message';
+import { Customs } from './customs';
+import { Products } from './products';
+import { DangerousGoodsPackageInfo } from './dangerous-good/dangerous-goods-package-info';
+/** @description Basic structure for a package */
+export declare class Package {
+    /** @description Package code defined for the carrier in ShipEngine. */
+    package_code?: string;
+    /** @description A summary of the content of a given package. Required to ship to and from Mexico. Maximum length of 35 characters. */
+    content_description?: string;
+    /** @description Details about the dimensions of the package */
+    dimension_details?: DimensionDetails;
+    /** @description Details about the weight of the package */
+    weight_details?: WeightDetails;
+    /** @description The insured value of this package. */
+    insured_value: Currency;
+    /** @description The message the seller requested to have on their label */
+    label_messages?: LabelMessage;
+    /** @deprecated For shipment-level information, the shipment `customs` object should be used, and for parcel-level items, the `packages.products` array should be used. */
+    customs?: Customs;
+    /** @description List of products goods model associated with this package passed to the carrier. */
+    products?: Products[];
+    /** @description An object containing information specific to the dangerous goods aspects of an individual package. */
+    dangerous_goods_package_info?: DangerousGoodsPackageInfo;
+}

package/lib/models/package.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Package = void 0;
+/** @description Basic structure for a package */
+class Package {
+    /** @description Package code defined for the carrier in ShipEngine. */
+    package_code;
+    /** @description A summary of the content of a given package. Required to ship to and from Mexico. Maximum length of 35 characters. */
+    content_description;
+    /** @description Details about the dimensions of the package */
+    dimension_details;
+    /** @description Details about the weight of the package */
+    weight_details;
+    /** @description The insured value of this package. */
+    insured_value;
+    /** @description The message the seller requested to have on their label */
+    label_messages;
+    /** @deprecated For shipment-level information, the shipment `customs` object should be used, and for parcel-level items, the `packages.products` array should be used. */
+    customs;
+    /** @description List of products goods model associated with this package passed to the carrier. */
+    products;
+    /** @description An object containing information specific to the dangerous goods aspects of an individual package. */
+    dangerous_goods_package_info;
+}
+exports.Package = Package;
+//# sourceMappingURL=package.js.map

package/lib/models/package.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.js","sourceRoot":"","sources":["../../src/models/package.ts"],"names":[],"mappings":";;;AAQA,iDAAiD;AACjD,MAAa,OAAO;IAClB,uEAAuE;IACvE,YAAY,CAAU;IACtB,sIAAsI;IACtI,mBAAmB,CAAU;IAC7B,+DAA+D;IAC/D,iBAAiB,CAAoB;IACrC,2DAA2D;IAC3D,cAAc,CAAiB;IAC/B,sDAAsD;IACtD,aAAa,CAAY;IACzB,2EAA2E;IAC3E,cAAc,CAAgB;IAC9B,0KAA0K;IAC1K,OAAO,CAAW;IAClB,oGAAoG;IACpG,QAAQ,CAAc;IACtB,sHAAsH;IACtH,4BAA4B,CAA6B;CAC1D;AAnBD,0BAmBC"}

package/lib/models/payment-terms.d.ts

@@ -0,0 +1,7 @@
+/** @description This model specifies whether the payment is required before the delivery of goods or services or if credit is extended to the customer.*/
+export declare enum PaymentTerms {
+    /** @description Payment must be made in full before the goods or services are delivered.*/
+    Prepaid = "prepaid",
+    /** @description Payment is deferred, allowing the customer to settle the invoice at a later agreed-upon date.*/
+    Credit = "credit"
+}

package/lib/models/payment-terms.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentTerms = void 0;
+/** @description This model specifies whether the payment is required before the delivery of goods or services or if credit is extended to the customer.*/
+var PaymentTerms;
+(function (PaymentTerms) {
+    /** @description Payment must be made in full before the goods or services are delivered.*/
+    PaymentTerms["Prepaid"] = "prepaid";
+    /** @description Payment is deferred, allowing the customer to settle the invoice at a later agreed-upon date.*/
+    PaymentTerms["Credit"] = "credit";
+})(PaymentTerms || (exports.PaymentTerms = PaymentTerms = {}));
+//# sourceMappingURL=payment-terms.js.map

package/lib/models/payment-terms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment-terms.js","sourceRoot":"","sources":["../../src/models/payment-terms.ts"],"names":[],"mappings":";;;AAAA,0JAA0J;AAC1J,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,2FAA2F;IAC3F,mCAAmB,CAAA;IACnB,gHAAgH;IAChH,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB"}

package/lib/models/pickup/cancellation-details.d.ts

@@ -0,0 +1,12 @@
+import { CancellationReason } from './cancellation-reason';
+/** @description Basic structure for a cancellation */
+export declare class CancellationDetails {
+    /** @description The reason the pickup has been cancelled */
+    reason: CancellationReason;
+    /** @description Additional properties about cancellation */
+    cancellation_options?: {
+        [key: string]: string;
+    };
+    /** @description Any additional info about why the customer is cancelling the pickup */
+    remarks?: string;
+}

package/lib/models/pickup/cancellation-details.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CancellationDetails = void 0;
+/** @description Basic structure for a cancellation */
+class CancellationDetails {
+    /** @description The reason the pickup has been cancelled */
+    reason;
+    /** @description Additional properties about cancellation */
+    cancellation_options;
+    /** @description Any additional info about why the customer is cancelling the pickup */
+    remarks;
+}
+exports.CancellationDetails = CancellationDetails;
+//# sourceMappingURL=cancellation-details.js.map

package/lib/models/pickup/cancellation-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancellation-details.js","sourceRoot":"","sources":["../../../src/models/pickup/cancellation-details.ts"],"names":[],"mappings":";;;AAEA,sDAAsD;AACtD,MAAa,mBAAmB;IAC9B,4DAA4D;IAC5D,MAAM,CAAsB;IAC5B,4DAA4D;IAC5D,oBAAoB,CAA6B;IACjD,uFAAuF;IACvF,OAAO,CAAU;CAClB;AAPD,kDAOC"}

package/lib/models/pickup/cancellation-reason.d.ts

@@ -0,0 +1,8 @@
+/** @description Reasons for cancellation */
+export declare enum CancellationReason {
+    Other = "other",
+    NotReady = "not_ready",
+    CostTooHigh = "cost_too_high",
+    ServiceTooSlow = "service_too_slow",
+    CarrierFailedPickup = "carrier_failed_pickup"
+}

package/lib/models/pickup/cancellation-reason.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CancellationReason = void 0;
+/** @description Reasons for cancellation */
+var CancellationReason;
+(function (CancellationReason) {
+    CancellationReason["Other"] = "other";
+    CancellationReason["NotReady"] = "not_ready";
+    CancellationReason["CostTooHigh"] = "cost_too_high";
+    CancellationReason["ServiceTooSlow"] = "service_too_slow";
+    CancellationReason["CarrierFailedPickup"] = "carrier_failed_pickup";
+})(CancellationReason || (exports.CancellationReason = CancellationReason = {}));
+//# sourceMappingURL=cancellation-reason.js.map

package/lib/models/pickup/cancellation-reason.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancellation-reason.js","sourceRoot":"","sources":["../../../src/models/pickup/cancellation-reason.ts"],"names":[],"mappings":";;;AAAA,4CAA4C;AAC5C,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,qCAAe,CAAA;IACf,4CAAsB,CAAA;IACtB,mDAA6B,CAAA;IAC7B,yDAAmC,CAAA;IACnC,mEAA6C,CAAA;AAC/C,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B"}

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

@@ -0,0 +1,14 @@
+export * from './cancellation-details';
+export * from './cancellation-reason';
+export * from './pickup-confirmation-schema';
+export * from './pickup-confirmation';
+export * from './pickup-contact-details';
+export * from './pickup-location-details';
+export * from './pickup-package';
+export * from './pickup-shipment-details';
+export * from './pickup-window-schema';
+export * from './pickup-window';
+export * from './shipment-identifier-schema';
+export * from './shipment-identifier';
+export * from './shipped-package';
+export * from './shipped-shipment';

package/lib/models/pickup/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./cancellation-details"), exports);
+tslib_1.__exportStar(require("./cancellation-reason"), exports);
+tslib_1.__exportStar(require("./pickup-confirmation-schema"), exports);
+tslib_1.__exportStar(require("./pickup-confirmation"), exports);
+tslib_1.__exportStar(require("./pickup-contact-details"), exports);
+tslib_1.__exportStar(require("./pickup-location-details"), exports);
+tslib_1.__exportStar(require("./pickup-package"), exports);
+tslib_1.__exportStar(require("./pickup-shipment-details"), exports);
+tslib_1.__exportStar(require("./pickup-window-schema"), exports);
+tslib_1.__exportStar(require("./pickup-window"), exports);
+tslib_1.__exportStar(require("./shipment-identifier-schema"), exports);
+tslib_1.__exportStar(require("./shipment-identifier"), exports);
+tslib_1.__exportStar(require("./shipped-package"), exports);
+tslib_1.__exportStar(require("./shipped-shipment"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/pickup/index.ts"],"names":[],"mappings":";;;AAAA,iEAAuC;AACvC,gEAAsC;AACtC,uEAA6C;AAC7C,gEAAsC;AACtC,mEAAyC;AACzC,oEAA0C;AAC1C,2DAAiC;AACjC,oEAA0C;AAC1C,iEAAuC;AACvC,0DAAgC;AAChC,uEAA6C;AAC7C,gEAAsC;AACtC,4DAAkC;AAClC,6DAAmC"}

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"pickup-confirmation-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-confirmation-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,4DAAwD;AACxD,6EAAwE;AAE3D,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;IACrE,oBAAoB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,qDAAwB,CAAC;CAC7E,CAAC,CAAC"}

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

@@ -0,0 +1,11 @@
+import { Identifier } from '../identifier';
+import { ShipmentIdentifier } from './shipment-identifier';
+/** @description Basic structure for a pickup confirmation */
+export declare class PickupConfirmation {
+    /** @description The primary confirmation ID for this request. */
+    confirmation_id?: string;
+    /** @description Other identifiers potentially needed in other calls. */
+    alternate_identifiers?: Identifier[];
+    /** @description List of the shipments added for this pickup. */
+    shipment_identifiers?: ShipmentIdentifier[];
+}

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

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PickupConfirmation = void 0;
+/** @description Basic structure for a pickup confirmation */
+class PickupConfirmation {
+    /** @description The primary confirmation ID for this request. */
+    confirmation_id;
+    /** @description Other identifiers potentially needed in other calls. */
+    alternate_identifiers;
+    /** @description List of the shipments added for this pickup. */
+    shipment_identifiers;
+}
+exports.PickupConfirmation = PickupConfirmation;
+//# sourceMappingURL=pickup-confirmation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pickup-confirmation.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-confirmation.ts"],"names":[],"mappings":";;;AAGA,6DAA6D;AAC7D,MAAa,kBAAkB;IAC7B,iEAAiE;IACjE,eAAe,CAAU;IACzB,wEAAwE;IACxE,qBAAqB,CAAgB;IACrC,gEAAgE;IAChE,oBAAoB,CAAwB;CAC7C;AAPD,gDAOC"}

package/lib/models/pickup/pickup-contact-details.d.ts

@@ -0,0 +1,13 @@
+/** @description Contact information for the person who will be present for the pickup. */
+export declare class PickupContactDetails {
+    /** @description The first name of the person who will be there for the pickup. */
+    first_name: string;
+    /** @description The last name of the person who will be there for the pickup. */
+    last_name?: string;
+    /** @description The e-mail address of the person who will be there for the pickup. */
+    email: string;
+    /** @description The phone number of the person who will be there for the pickup. */
+    phone_number: string;
+    /** @description The phone extension of the person who will be there for the pickup. */
+    phone_number_extension?: string;
+}

package/lib/models/pickup/pickup-contact-details.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PickupContactDetails = void 0;
+/** @description Contact information for the person who will be present for the pickup. */
+class PickupContactDetails {
+    /** @description The first name of the person who will be there for the pickup. */
+    first_name;
+    /** @description The last name of the person who will be there for the pickup. */
+    last_name;
+    /** @description The e-mail address of the person who will be there for the pickup. */
+    email;
+    /** @description The phone number of the person who will be there for the pickup. */
+    phone_number;
+    /** @description The phone extension of the person who will be there for the pickup. */
+    phone_number_extension;
+}
+exports.PickupContactDetails = PickupContactDetails;
+//# sourceMappingURL=pickup-contact-details.js.map

package/lib/models/pickup/pickup-contact-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pickup-contact-details.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-contact-details.ts"],"names":[],"mappings":";;;AAAA,0FAA0F;AAC1F,MAAa,oBAAoB;IAC/B,kFAAkF;IAClF,UAAU,CAAU;IACpB,iFAAiF;IACjF,SAAS,CAAU;IACnB,sFAAsF;IACtF,KAAK,CAAU;IACf,oFAAoF;IACpF,YAAY,CAAU;IACtB,uFAAuF;IACvF,sBAAsB,CAAU;CACjC;AAXD,oDAWC"}

package/lib/models/pickup/pickup-location-details.d.ts

@@ -0,0 +1,12 @@
+import { ShipFrom } from '../addresses/ship-from';
+/** @description Location details for pickup */
+export declare class PickupLocationDetails {
+    /** @description The address the pickup will take place */
+    pickup_address?: ShipFrom;
+    /** @description Any notes that may be helpful for a driver to find the pickup location */
+    location_notes?: string;
+    /** @description Custom options that are used by the carrier to determine pickup locations */
+    pickup_options?: {
+        [key: string]: string;
+    };
+}

package/lib/models/pickup/pickup-location-details.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PickupLocationDetails = void 0;
+/** @description Location details for pickup */
+class PickupLocationDetails {
+    /** @description The address the pickup will take place */
+    pickup_address;
+    /** @description Any notes that may be helpful for a driver to find the pickup location */
+    location_notes;
+    /** @description Custom options that are used by the carrier to determine pickup locations */
+    pickup_options;
+}
+exports.PickupLocationDetails = PickupLocationDetails;
+//# sourceMappingURL=pickup-location-details.js.map

package/lib/models/pickup/pickup-location-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pickup-location-details.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-location-details.ts"],"names":[],"mappings":";;;AAEA,+CAA+C;AAC/C,MAAa,qBAAqB;IAChC,0DAA0D;IAC1D,cAAc,CAAY;IAC1B,0FAA0F;IAC1F,cAAc,CAAU;IACxB,6FAA6F;IAC7F,cAAc,CAA6B;CAC5C;AAPD,sDAOC"}

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

@@ -0,0 +1,21 @@
+import { Identifier } from '../identifier';
+import { DimensionDetails } from '../units/dimension-details';
+import { WeightDetails } from '../units/weight-details';
+import { Dimensions } from '../units/dimensions';
+/** @description Basic structure for a package to be picked up */
+export declare class PickupPackage {
+    /** @description The carrier tracking number for this shipment */
+    tracking_number?: 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;
+}

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PickupPackage = void 0;
+/** @description Basic structure for a package to be picked up */
+class PickupPackage {
+    /** @description The carrier tracking number for this shipment */
+    tracking_number;
+    /** @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;
+}
+exports.PickupPackage = PickupPackage;
+//# sourceMappingURL=pickup-package.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pickup-package.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-package.ts"],"names":[],"mappings":";;;AAKA,iEAAiE;AACjE,MAAa,aAAa;IACxB,iEAAiE;IACjE,eAAe,CAAU;IACzB,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;CACzB;AAfD,sCAeC"}

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

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

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PickupSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+exports.PickupSchema = joi_1.default.object({
+    confirmation_number: joi_1.default.string().required(),
+    status: joi_1.default.string().required(),
+    status_reason: joi_1.default.string().optional(),
+});
+//# sourceMappingURL=pickup-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pickup-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAET,QAAA,YAAY,GAAG,aAAG,CAAC,MAAM,CAAC;IACrC,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5C,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC"}

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

@@ -0,0 +1,8 @@
+import { ShippedShipment } from './shipped-shipment';
+/** @description Details for a pickup shipment */
+export declare class PickupShipmentDetails {
+    /** @description Service category for the carrier (ground, express, next_day) */
+    pickup_service_code?: string;
+    /** @description List of shipments to be picked up */
+    shipments?: ShippedShipment[];
+}

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PickupShipmentDetails = void 0;
+/** @description Details for a pickup shipment */
+class PickupShipmentDetails {
+    /** @description Service category for the carrier (ground, express, next_day) */
+    pickup_service_code;
+    /** @description List of shipments to be picked up */
+    shipments;
+}
+exports.PickupShipmentDetails = PickupShipmentDetails;
+//# sourceMappingURL=pickup-shipment-details.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pickup-shipment-details.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-shipment-details.ts"],"names":[],"mappings":";;;AAEA,iDAAiD;AACjD,MAAa,qBAAqB;IAChC,gFAAgF;IAChF,mBAAmB,CAAU;IAC7B,qDAAqD;IACrD,SAAS,CAAqB;CAC/B;AALD,sDAKC"}

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

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

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PickupWindowSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+exports.PickupWindowSchema = joi_1.default.object({
+    time_zone_iana: joi_1.default.string().required(),
+    pickup_date: joi_1.default.string().required().isoDate(),
+    start_time: joi_1.default.string().optional().isoDate(),
+    end_time: joi_1.default.string().optional().isoDate(),
+});
+//# sourceMappingURL=pickup-window-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pickup-window-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-window-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAET,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE;IAC9C,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE;IAC7C,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE;CAC5C,CAAC,CAAC"}

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

@@ -0,0 +1,11 @@
+/** @description This model represents a window of time a pickup could be made. */
+export declare class PickupWindow {
+    /** @description The local time zone represented in IANA. See https://www.iana.org/time-zones */
+    time_zone_iana: string;
+    /** @description The local date the pickup will occur. Formatted per https://tools.ietf.org/html/rfc3339 */
+    pickup_date: string;
+    /** @description The time relative to the time_zone_iana that the carrier says that the pickup could occur. Formatted per https://tools.ietf.org/html/rfc3339 */
+    start_time?: string;
+    /** @description The end of the window when the pickup could be made relative to the time_zone_iana. Formatted per https://tools.ietf.org/html/rfc3339 */
+    end_time?: string;
+}

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PickupWindow = void 0;
+/** @description This model represents a window of time a pickup could be made. */
+class PickupWindow {
+    /** @description The local time zone represented in IANA. See https://www.iana.org/time-zones */
+    time_zone_iana;
+    /** @description The local date the pickup will occur. Formatted per https://tools.ietf.org/html/rfc3339 */
+    pickup_date;
+    /** @description The time relative to the time_zone_iana that the carrier says that the pickup could occur. Formatted per https://tools.ietf.org/html/rfc3339 */
+    start_time;
+    /** @description The end of the window when the pickup could be made relative to the time_zone_iana. Formatted per https://tools.ietf.org/html/rfc3339 */
+    end_time;
+}
+exports.PickupWindow = PickupWindow;
+//# sourceMappingURL=pickup-window.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pickup-window.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup-window.ts"],"names":[],"mappings":";;;AAAA,kFAAkF;AAClF,MAAa,YAAY;IACvB,gGAAgG;IAChG,cAAc,CAAU;IACxB,2GAA2G;IAC3G,WAAW,CAAU;IACrB,gKAAgK;IAChK,UAAU,CAAU;IACpB,yJAAyJ;IACzJ,QAAQ,CAAU;CACnB;AATD,oCASC"}

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

@@ -0,0 +1,5 @@
+export declare class Pickup {
+    confirmation_number: string;
+    status: string;
+    status_reason?: string;
+}

package/lib/models/pickup/pickup.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Pickup = void 0;
+class Pickup {
+    confirmation_number;
+    status;
+    status_reason;
+}
+exports.Pickup = Pickup;
+//# sourceMappingURL=pickup.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pickup.js","sourceRoot":"","sources":["../../../src/models/pickup/pickup.ts"],"names":[],"mappings":";;;AAAA,MAAa,MAAM;IACjB,mBAAmB,CAAU;IAC7B,MAAM,CAAU;IAChB,aAAa,CAAU;CACxB;AAJD,wBAIC"}

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

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