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

package/lib/models/tracking/tracking-info.d.ts

@@ -0,0 +1,48 @@
+import { StandardizedStatusCodes } from './standardized-status-codes';
+import { Dimensions } from '../units/dimensions';
+import { Service } from './service';
+import { TrackEvent } from './track-event';
+import { StandardizedStatusDetailCodes } from './standardized-status-detail-codes';
+/** @description Basic structure for tracking information */
+export declare class TrackingInfo {
+    /** @description The human readable name of the carrier tracking this shipment. */
+    carrier_name?: string;
+    /** @description The carrier specific tracking identifier for this shipment. */
+    tracking_number?: string;
+    /** @description This represents the ShipEngine supported status codes for a shipment. UN - Unknown AC - Accepted IT - In Transit DE - Delivered EX - Exception AT - Delivery Attempted NY - Not Yet In System */
+    standardized_status_code?: StandardizedStatusCodes;
+    /** @description This represents the ShipEngine supported status detil codes for a shipment. */
+    standardized_status_detail_code?: StandardizedStatusDetailCodes;
+    /** @description If the carrier returns both a generic and a specific tracking status code for the shipment, this field should contain the generic value while `carrier_detail_code` should contain the specific value. Otherwise, this field contains the carrier's specific status code. */
+    carrier_status_code?: string;
+    /** @description Optional field for the carrier's specific tracking status code when `carrier_status_code` is populated with a generic status code. */
+    carrier_detail_code?: string;
+    /** @description The human readable description of this shipment's tracking status. */
+    carrier_status_description?: string;
+    /** @description When the package(s) in this shipment were turned over to the carrier. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
+    shipped_datetime?: string;
+    /** @description When the package(s) in this shipment are expected to arrive at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
+    estimated_delivery_datetime?: string;
+    /** @description When the package(s) in this shipment arrived at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
+    actual_delivery_datetime?: string;
+    /** @description A human readable description of why the shipment is in an error state. */
+    shipping_problem_description?: string;
+    /** @description The weight measured by the carrier of the package(s) in this shipment. */
+    weight?: number;
+    /** @description The dimensions measured by the carrier of the package(s) in this shipment. */
+    dimensions?: Dimensions;
+    /** @description A shipping provider specific service. */
+    service?: Service;
+    /** @description The carrier packaging code. */
+    packaging?: string;
+    /** @description The carrier observed count of packages in this shipment. */
+    package_count?: number;
+    /** @description A list of tracking events for this shipment */
+    events?: TrackEvent[];
+    /** @description Whether or not this shipment has entered an error state. */
+    shipping_problem?: boolean;
+    /** @description The unique identifying code for the type of error encountered by this shipment. */
+    shipping_problem_code?: string;
+    /** @description The human readable explanation of the error encountered by this shipment. */
+    error_description?: string;
+}

package/lib/models/tracking/tracking-info.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrackingInfo = void 0;
+/** @description Basic structure for tracking information */
+class TrackingInfo {
+    /** @description The human readable name of the carrier tracking this shipment. */
+    carrier_name;
+    /** @description The carrier specific tracking identifier for this shipment. */
+    tracking_number;
+    /** @description This represents the ShipEngine supported status codes for a shipment. UN - Unknown AC - Accepted IT - In Transit DE - Delivered EX - Exception AT - Delivery Attempted NY - Not Yet In System */
+    standardized_status_code;
+    /** @description This represents the ShipEngine supported status detil codes for a shipment. */
+    standardized_status_detail_code;
+    /** @description If the carrier returns both a generic and a specific tracking status code for the shipment, this field should contain the generic value while `carrier_detail_code` should contain the specific value. Otherwise, this field contains the carrier's specific status code. */
+    carrier_status_code;
+    /** @description Optional field for the carrier's specific tracking status code when `carrier_status_code` is populated with a generic status code. */
+    carrier_detail_code;
+    /** @description The human readable description of this shipment's tracking status. */
+    carrier_status_description;
+    /** @description When the package(s) in this shipment were turned over to the carrier. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
+    shipped_datetime;
+    /** @description When the package(s) in this shipment are expected to arrive at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
+    estimated_delivery_datetime;
+    /** @description When the package(s) in this shipment arrived at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
+    actual_delivery_datetime;
+    /** @description A human readable description of why the shipment is in an error state. */
+    shipping_problem_description;
+    /** @description The weight measured by the carrier of the package(s) in this shipment. */
+    weight;
+    /** @description The dimensions measured by the carrier of the package(s) in this shipment. */
+    dimensions;
+    /** @description A shipping provider specific service. */
+    service;
+    /** @description The carrier packaging code. */
+    packaging;
+    /** @description The carrier observed count of packages in this shipment. */
+    package_count;
+    /** @description A list of tracking events for this shipment */
+    events;
+    /** @description Whether or not this shipment has entered an error state. */
+    shipping_problem;
+    /** @description The unique identifying code for the type of error encountered by this shipment. */
+    shipping_problem_code;
+    /** @description The human readable explanation of the error encountered by this shipment. */
+    error_description;
+}
+exports.TrackingInfo = TrackingInfo;
+//# sourceMappingURL=tracking-info.js.map

package/lib/models/tracking/tracking-info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracking-info.js","sourceRoot":"","sources":["../../../src/models/tracking/tracking-info.ts"],"names":[],"mappings":";;;AAMA,4DAA4D;AAC5D,MAAa,YAAY;IACvB,kFAAkF;IAClF,YAAY,CAAU;IACtB,+EAA+E;IAC/E,eAAe,CAAU;IACzB,iNAAiN;IACjN,wBAAwB,CAA2B;IACnD,+FAA+F;IAC/F,+BAA+B,CAAiC;IAChE,6RAA6R;IAC7R,mBAAmB,CAAU;IAC7B,sJAAsJ;IACtJ,mBAAmB,CAAU;IAC7B,sFAAsF;IACtF,0BAA0B,CAAU;IACpC,4JAA4J;IAC5J,gBAAgB,CAAU;IAC1B,wKAAwK;IACxK,2BAA2B,CAAU;IACrC,yJAAyJ;IACzJ,wBAAwB,CAAU;IAClC,0FAA0F;IAC1F,4BAA4B,CAAU;IACtC,0FAA0F;IAC1F,MAAM,CAAU;IAChB,8FAA8F;IAC9F,UAAU,CAAc;IACxB,yDAAyD;IACzD,OAAO,CAAW;IAClB,+CAA+C;IAC/C,SAAS,CAAU;IACnB,4EAA4E;IAC5E,aAAa,CAAU;IACvB,+DAA+D;IAC/D,MAAM,CAAgB;IACtB,4EAA4E;IAC5E,gBAAgB,CAAW;IAC3B,mGAAmG;IACnG,qBAAqB,CAAU;IAC/B,6FAA6F;IAC7F,iBAAiB,CAAU;CAC5B;AAzCD,oCAyCC"}

package/lib/models/tracking/update-method-schema.d.ts

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

package/lib/models/tracking/update-method-schema.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateMethodsSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const update_method_1 = require("./update-method");
+exports.UpdateMethodsSchema = joi_1.default.string().valid(...Object.values(update_method_1.UpdateMethods));
+//# sourceMappingURL=update-method-schema.js.map

package/lib/models/tracking/update-method-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-method-schema.js","sourceRoot":"","sources":["../../../src/models/tracking/update-method-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,mDAAgD;AAEnC,QAAA,mBAAmB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,6BAAa,CAAC,CAAC,CAAC"}

package/lib/models/tracking/update-method.d.ts

@@ -0,0 +1,7 @@
+/** @description Update method to use for the tracking information */
+export declare enum UpdateMethods {
+    /** @description Append the new data to the existing data set */
+    Append = "append",
+    /** @description Replace the existing data set with the new data */
+    Replace = "replace"
+}

package/lib/models/tracking/update-method.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateMethods = void 0;
+/** @description Update method to use for the tracking information */
+var UpdateMethods;
+(function (UpdateMethods) {
+    /** @description Append the new data to the existing data set */
+    UpdateMethods["Append"] = "append";
+    /** @description Replace the existing data set with the new data */
+    UpdateMethods["Replace"] = "replace";
+})(UpdateMethods || (exports.UpdateMethods = UpdateMethods = {}));
+//# sourceMappingURL=update-method.js.map

package/lib/models/tracking/update-method.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-method.js","sourceRoot":"","sources":["../../../src/models/tracking/update-method.ts"],"names":[],"mappings":";;;AAAA,qEAAqE;AACrE,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,gEAAgE;IAChE,kCAAiB,CAAA;IACjB,mEAAmE;IACnE,oCAAmB,CAAA;AACrB,CAAC,EALW,aAAa,6BAAb,aAAa,QAKxB"}

package/lib/models/units/carrier-weight.d.ts

@@ -0,0 +1,8 @@
+import { WeightUnit } from './weight-unit';
+/** @description Represents the actual weight and unit supplied by a carrier based on the ingredients provided. */
+export declare class CarrierWeight {
+    /**  @description The actual weight value assessed by the carrier based on the ingredients provided, it may be used for customer billing purposes.  */
+    value?: number;
+    /** @description The unit of measurement for the carrier weight, it may be used for customer billing purposes. */
+    unit: WeightUnit;
+}

package/lib/models/units/carrier-weight.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CarrierWeight = void 0;
+/** @description Represents the actual weight and unit supplied by a carrier based on the ingredients provided. */
+class CarrierWeight {
+    /**  @description The actual weight value assessed by the carrier based on the ingredients provided, it may be used for customer billing purposes.  */
+    value;
+    /** @description The unit of measurement for the carrier weight, it may be used for customer billing purposes. */
+    unit;
+}
+exports.CarrierWeight = CarrierWeight;
+//# sourceMappingURL=carrier-weight.js.map

package/lib/models/units/carrier-weight.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"carrier-weight.js","sourceRoot":"","sources":["../../../src/models/units/carrier-weight.ts"],"names":[],"mappings":";;;AAEA,kHAAkH;AAClH,MAAa,aAAa;IACxB,sJAAsJ;IACtJ,KAAK,CAAU;IACf,iHAAiH;IACjH,IAAI,CAAc;CACnB;AALD,sCAKC"}

package/lib/models/units/dimension-details-schema.d.ts

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

package/lib/models/units/dimension-details-schema.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DimensionDetailsSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const dimensions_schema_1 = require("./dimensions-schema");
+const dimension_unit_schema_1 = require("./dimension-unit-schema");
+exports.DimensionDetailsSchema = joi_1.default.object({
+    dimensions_in_centimeters: dimensions_schema_1.DimensionsSchema.optional(),
+    dimensions_in_inches: dimensions_schema_1.DimensionsSchema.optional(),
+    source_dimensions: dimensions_schema_1.DimensionsSchema.optional(),
+    source_dimension_unit: dimension_unit_schema_1.DimensionUnitSchema.required(),
+});
+//# sourceMappingURL=dimension-details-schema.js.map

package/lib/models/units/dimension-details-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dimension-details-schema.js","sourceRoot":"","sources":["../../../src/models/units/dimension-details-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,2DAAuD;AACvD,mEAA8D;AAEjD,QAAA,sBAAsB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC/C,yBAAyB,EAAE,oCAAgB,CAAC,QAAQ,EAAE;IACtD,oBAAoB,EAAE,oCAAgB,CAAC,QAAQ,EAAE;IACjD,iBAAiB,EAAE,oCAAgB,CAAC,QAAQ,EAAE;IAC9C,qBAAqB,EAAE,2CAAmB,CAAC,QAAQ,EAAE;CACtD,CAAC,CAAC"}

package/lib/models/units/dimension-details.d.ts

@@ -0,0 +1,13 @@
+import { Dimensions } from './dimensions';
+import { DimensionUnit } from './dimension-unit';
+/** @description Basic structure for package dimensions */
+export declare class DimensionDetails {
+    /** @description This contains information about the dimensions in centimeters. This will always be present on the request */
+    dimensions_in_centimeters?: Dimensions;
+    /** @description This contains information about the dimensions in inches. This will always be present on the request */
+    dimensions_in_inches?: Dimensions;
+    /** @description This contains information about the dimensions in the source units. This will always be present on the request */
+    source_dimensions?: Dimensions;
+    /** @description The source units the customer provided */
+    source_dimension_unit: DimensionUnit;
+}

package/lib/models/units/dimension-details.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DimensionDetails = void 0;
+/** @description Basic structure for package dimensions */
+class DimensionDetails {
+    /** @description This contains information about the dimensions in centimeters. This will always be present on the request */
+    dimensions_in_centimeters;
+    /** @description This contains information about the dimensions in inches. This will always be present on the request */
+    dimensions_in_inches;
+    /** @description This contains information about the dimensions in the source units. This will always be present on the request */
+    source_dimensions;
+    /** @description The source units the customer provided */
+    source_dimension_unit;
+}
+exports.DimensionDetails = DimensionDetails;
+//# sourceMappingURL=dimension-details.js.map

package/lib/models/units/dimension-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dimension-details.js","sourceRoot":"","sources":["../../../src/models/units/dimension-details.ts"],"names":[],"mappings":";;;AAGA,0DAA0D;AAC1D,MAAa,gBAAgB;IAC3B,6HAA6H;IAC7H,yBAAyB,CAAc;IACvC,wHAAwH;IACxH,oBAAoB,CAAc;IAClC,kIAAkI;IAClI,iBAAiB,CAAc;IAC/B,0DAA0D;IAC1D,qBAAqB,CAAiB;CACvC;AATD,4CASC"}

package/lib/models/units/dimension-unit-schema.d.ts

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

package/lib/models/units/dimension-unit-schema.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DimensionUnitSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const dimension_unit_1 = require("./dimension-unit");
+exports.DimensionUnitSchema = joi_1.default.string().valid(...Object.values(dimension_unit_1.DimensionUnit));
+//# sourceMappingURL=dimension-unit-schema.js.map

package/lib/models/units/dimension-unit-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dimension-unit-schema.js","sourceRoot":"","sources":["../../../src/models/units/dimension-unit-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,qDAAiD;AAEpC,QAAA,mBAAmB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,8BAAa,CAAC,CAAC,CAAC"}

package/lib/models/units/dimension-unit.d.ts

@@ -0,0 +1,5 @@
+/** @description Unit of measurement for dimensions */
+export declare enum DimensionUnit {
+    Inches = "inches",
+    Centimeters = "centimeters"
+}

package/lib/models/units/dimension-unit.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DimensionUnit = void 0;
+/** @description Unit of measurement for dimensions */
+var DimensionUnit;
+(function (DimensionUnit) {
+    DimensionUnit["Inches"] = "inches";
+    DimensionUnit["Centimeters"] = "centimeters";
+})(DimensionUnit || (exports.DimensionUnit = DimensionUnit = {}));
+//# sourceMappingURL=dimension-unit.js.map

package/lib/models/units/dimension-unit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dimension-unit.js","sourceRoot":"","sources":["../../../src/models/units/dimension-unit.ts"],"names":[],"mappings":";;;AAAA,sDAAsD;AACtD,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,4CAA2B,CAAA;AAC7B,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB"}

package/lib/models/units/dimensions-schema.d.ts

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

package/lib/models/units/dimensions-schema.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DimensionsSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+exports.DimensionsSchema = joi_1.default.object({
+    length: joi_1.default.number().optional(),
+    width: joi_1.default.number().optional(),
+    height: joi_1.default.number().optional(),
+});
+//# sourceMappingURL=dimensions-schema.js.map

package/lib/models/units/dimensions-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dimensions-schema.js","sourceRoot":"","sources":["../../../src/models/units/dimensions-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAET,QAAA,gBAAgB,GAAG,aAAG,CAAC,MAAM,CAAC;IACzC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC"}

package/lib/models/units/dimensions.d.ts

@@ -0,0 +1,6 @@
+/** @description Basic structure for dimensions */
+export declare class Dimensions {
+    length?: number;
+    width?: number;
+    height?: number;
+}

package/lib/models/units/dimensions.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Dimensions = void 0;
+/** @description Basic structure for dimensions */
+class Dimensions {
+    length;
+    width;
+    height;
+}
+exports.Dimensions = Dimensions;
+//# sourceMappingURL=dimensions.js.map

package/lib/models/units/dimensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dimensions.js","sourceRoot":"","sources":["../../../src/models/units/dimensions.ts"],"names":[],"mappings":";;;AAAA,kDAAkD;AAClD,MAAa,UAAU;IACrB,MAAM,CAAU;IAChB,KAAK,CAAU;IACf,MAAM,CAAU;CACjB;AAJD,gCAIC"}

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

@@ -0,0 +1,6 @@
+export * from './dimension-details';
+export * from './dimension-unit';
+export * from './dimensions-schema';
+export * from './dimensions';
+export * from './weight-details';
+export * from './weight-unit';

package/lib/models/units/index.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/units/index.ts"],"names":[],"mappings":";;;AAAA,8DAAoC;AACpC,2DAAiC;AACjC,8DAAoC;AACpC,uDAA6B;AAC7B,2DAAiC;AACjC,wDAA8B"}

package/lib/models/units/weight-details-schema.d.ts

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

package/lib/models/units/weight-details-schema.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WeightDetailsSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const weight_unit_schema_1 = require("./weight-unit-schema");
+exports.WeightDetailsSchema = joi_1.default.object({
+    weight_in_ounces: joi_1.default.number().optional,
+    weight_in_grams: joi_1.default.number().optional,
+    source_weight: joi_1.default.number().optional,
+    source_weight_unit: weight_unit_schema_1.WeightUnitSchema.required(),
+});
+//# sourceMappingURL=weight-details-schema.js.map

package/lib/models/units/weight-details-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"weight-details-schema.js","sourceRoot":"","sources":["../../../src/models/units/weight-details-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,6DAAwD;AAE3C,QAAA,mBAAmB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC5C,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ;IACvC,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ;IACtC,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ;IACpC,kBAAkB,EAAE,qCAAgB,CAAC,QAAQ,EAAE;CAChD,CAAC,CAAC"}

package/lib/models/units/weight-details.d.ts

@@ -0,0 +1,12 @@
+import { WeightUnit } from './weight-unit';
+/** @description Basic structure for weight */
+export declare class WeightDetails {
+    /** @description This contains information about the weight in ounces. This will always be present on the request */
+    weight_in_ounces?: number;
+    /** @description This contains information about the weight in grams. This will always be present on the request */
+    weight_in_grams?: number;
+    /** @description This contains information about the weight in source unit. This will always be present on the request */
+    source_weight?: number;
+    /** @description The source units the customer provided */
+    source_weight_unit: WeightUnit;
+}

package/lib/models/units/weight-details.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WeightDetails = void 0;
+/** @description Basic structure for weight */
+class WeightDetails {
+    /** @description This contains information about the weight in ounces. This will always be present on the request */
+    weight_in_ounces;
+    /** @description This contains information about the weight in grams. This will always be present on the request */
+    weight_in_grams;
+    /** @description This contains information about the weight in source unit. This will always be present on the request */
+    source_weight;
+    /** @description The source units the customer provided */
+    source_weight_unit;
+}
+exports.WeightDetails = WeightDetails;
+//# sourceMappingURL=weight-details.js.map

package/lib/models/units/weight-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"weight-details.js","sourceRoot":"","sources":["../../../src/models/units/weight-details.ts"],"names":[],"mappings":";;;AAEA,8CAA8C;AAC9C,MAAa,aAAa;IACxB,oHAAoH;IACpH,gBAAgB,CAAU;IAC1B,mHAAmH;IACnH,eAAe,CAAU;IACzB,yHAAyH;IACzH,aAAa,CAAU;IACvB,0DAA0D;IAC1D,kBAAkB,CAAc;CACjC;AATD,sCASC"}

package/lib/models/units/weight-unit-schema.d.ts

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

package/lib/models/units/weight-unit-schema.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WeightUnitSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const weight_unit_1 = require("./weight-unit");
+exports.WeightUnitSchema = joi_1.default.string().valid(...Object.values(weight_unit_1.WeightUnit));
+//# sourceMappingURL=weight-unit-schema.js.map

package/lib/models/units/weight-unit-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"weight-unit-schema.js","sourceRoot":"","sources":["../../../src/models/units/weight-unit-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,+CAA2C;AAE9B,QAAA,gBAAgB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,wBAAU,CAAC,CAAC,CAAC"}

package/lib/models/units/weight-unit.d.ts

@@ -0,0 +1,7 @@
+/** @description Unit of measurement for weight */
+export declare enum WeightUnit {
+    Grams = "grams",
+    Ounces = "ounces",
+    Kilograms = "kilograms",
+    Pounds = "pounds"
+}

package/lib/models/units/weight-unit.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WeightUnit = void 0;
+/** @description Unit of measurement for weight */
+var WeightUnit;
+(function (WeightUnit) {
+    WeightUnit["Grams"] = "grams";
+    WeightUnit["Ounces"] = "ounces";
+    WeightUnit["Kilograms"] = "kilograms";
+    WeightUnit["Pounds"] = "pounds";
+})(WeightUnit || (exports.WeightUnit = WeightUnit = {}));
+//# sourceMappingURL=weight-unit.js.map

package/lib/models/units/weight-unit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"weight-unit.js","sourceRoot":"","sources":["../../../src/models/units/weight-unit.ts"],"names":[],"mappings":";;;AAAA,kDAAkD;AAClD,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,6BAAe,CAAA;IACf,+BAAiB,CAAA;IACjB,qCAAuB,CAAA;IACvB,+BAAiB,CAAA;AACnB,CAAC,EALW,UAAU,0BAAV,UAAU,QAKrB"}

package/lib/models/windsor-framework/movement_indicator.d.ts

@@ -0,0 +1,6 @@
+export declare enum MovementIndicator {
+    B2C = "b2c",
+    B2B = "b2b",
+    C2C = "c2c",
+    C2B = "c2b"
+}

package/lib/models/windsor-framework/movement_indicator.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MovementIndicator = void 0;
+var MovementIndicator;
+(function (MovementIndicator) {
+    MovementIndicator["B2C"] = "b2c";
+    MovementIndicator["B2B"] = "b2b";
+    MovementIndicator["C2C"] = "c2c";
+    MovementIndicator["C2B"] = "c2b";
+})(MovementIndicator || (exports.MovementIndicator = MovementIndicator = {}));
+//# sourceMappingURL=movement_indicator.js.map

package/lib/models/windsor-framework/movement_indicator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"movement_indicator.js","sourceRoot":"","sources":["../../../src/models/windsor-framework/movement_indicator.ts"],"names":[],"mappings":";;;AAAA,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,gCAAW,CAAA;IACX,gCAAW,CAAA;IACX,gCAAW,CAAA;IACX,gCAAW,CAAA;AACb,CAAC,EALW,iBAAiB,iCAAjB,iBAAiB,QAK5B"}

package/lib/models/windsor-framework/windsor_framework_details.d.ts

@@ -0,0 +1,5 @@
+import { MovementIndicator } from './movement_indicator';
+export declare class WindsorFrameworkDetails {
+    not_at_risk?: boolean;
+    movement_indicator?: MovementIndicator;
+}

package/lib/models/windsor-framework/windsor_framework_details.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WindsorFrameworkDetails = void 0;
+class WindsorFrameworkDetails {
+    not_at_risk;
+    movement_indicator;
+}
+exports.WindsorFrameworkDetails = WindsorFrameworkDetails;
+//# sourceMappingURL=windsor_framework_details.js.map

package/lib/models/windsor-framework/windsor_framework_details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"windsor_framework_details.js","sourceRoot":"","sources":["../../../src/models/windsor-framework/windsor_framework_details.ts"],"names":[],"mappings":";;;AAEA,MAAa,uBAAuB;IAClC,WAAW,CAAW;IACtB,kBAAkB,CAAqB;CACxC;AAHD,0DAGC"}

package/lib/requests/base-request-schema.d.ts

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

package/lib/requests/base-request-schema.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseRequestSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const authorization_schema_1 = require("../models/authorization-schema");
+exports.BaseRequestSchema = joi_1.default.object({
+    transaction_id: joi_1.default.string().required(),
+    authorization: authorization_schema_1.AuthorizationSchema.optional(),
+    metadata: joi_1.default.object().pattern(/.*/, [joi_1.default.any()]).optional(),
+});
+//# sourceMappingURL=base-request-schema.js.map

package/lib/requests/base-request-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-request-schema.js","sourceRoot":"","sources":["../../src/requests/base-request-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,yEAAqE;AAExD,QAAA,iBAAiB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC1C,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,aAAa,EAAE,0CAAmB,CAAC,QAAQ,EAAE;IAC7C,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,aAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC7D,CAAC,CAAC"}

package/lib/requests/base-request.d.ts

@@ -0,0 +1,11 @@
+import { ConnectionNames } from '../app/metadata/connection-names-configuration';
+import { Authorization } from '../models';
+export declare class BaseRequest {
+    transaction_id: string;
+    authorization?: Authorization;
+    metadata?: {
+        [key: string]: any;
+    };
+    /** @description The name of the connection used, if this app has {@link ConnectionNamesConfiguration} defined*/
+    connection_name?: ConnectionNames;
+}

package/lib/requests/base-request.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseRequest = void 0;
+class BaseRequest {
+    transaction_id;
+    authorization;
+    metadata;
+    /** @description The name of the connection used, if this app has {@link ConnectionNamesConfiguration} defined*/
+    connection_name;
+}
+exports.BaseRequest = BaseRequest;
+//# sourceMappingURL=base-request.js.map

package/lib/requests/base-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-request.js","sourceRoot":"","sources":["../../src/requests/base-request.ts"],"names":[],"mappings":";;;AAGA,MAAa,WAAW;IACtB,cAAc,CAAU;IACxB,aAAa,CAAiB;IAC9B,QAAQ,CAA0B;IAClC,gHAAgH;IAChH,eAAe,CAAmB;CACnC;AAND,kCAMC"}

package/lib/requests/cancel-notification-request.d.ts

@@ -0,0 +1,8 @@
+import { ShippedShipment } from '../models';
+import { BaseRequest } from './base-request';
+export declare class CancelNotificationRequest extends BaseRequest {
+    /** @description The id of the notification */
+    notification_id: string;
+    /** @description The shipment to which the notification pertains */
+    shipment_information: ShippedShipment;
+}

package/lib/requests/cancel-notification-request.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CancelNotificationRequest = void 0;
+const base_request_1 = require("./base-request");
+class CancelNotificationRequest extends base_request_1.BaseRequest {
+    /** @description The id of the notification */
+    notification_id;
+    /** @description The shipment to which the notification pertains */
+    shipment_information;
+}
+exports.CancelNotificationRequest = CancelNotificationRequest;
+//# sourceMappingURL=cancel-notification-request.js.map

package/lib/requests/cancel-notification-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancel-notification-request.js","sourceRoot":"","sources":["../../src/requests/cancel-notification-request.ts"],"names":[],"mappings":";;;AACA,iDAA6C;AAE7C,MAAa,yBAA0B,SAAQ,0BAAW;IACxD,8CAA8C;IAC9C,eAAe,CAAU;IACzB,mEAAmE;IACnE,oBAAoB,CAAmB;CACxC;AALD,8DAKC"}

package/lib/requests/cancel-pickup-request.d.ts

@@ -0,0 +1,14 @@
+import { BaseRequest } from './base-request';
+import { CancellationDetails, PickupConfirmation, PickupContactDetails, PickupLocationDetails, PickupShipmentDetails, PickupWindow } from '../models';
+/** @description Basic structure for a request to cancel pickup */
+export declare class CancelPickupRequest extends BaseRequest {
+    confirmation?: PickupConfirmation;
+    location?: PickupLocationDetails;
+    cancellation_details?: CancellationDetails;
+    contact?: PickupContactDetails;
+    pickup_details?: PickupShipmentDetails;
+    pickup_windows?: PickupWindow[];
+    custom_properties?: {
+        [key: string]: string;
+    };
+}

package/lib/requests/cancel-pickup-request.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CancelPickupRequest = void 0;
+const base_request_1 = require("./base-request");
+/** @description Basic structure for a request to cancel pickup */
+class CancelPickupRequest extends base_request_1.BaseRequest {
+    confirmation;
+    location;
+    cancellation_details;
+    contact;
+    pickup_details;
+    pickup_windows;
+    custom_properties;
+}
+exports.CancelPickupRequest = CancelPickupRequest;
+//# sourceMappingURL=cancel-pickup-request.js.map

package/lib/requests/cancel-pickup-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancel-pickup-request.js","sourceRoot":"","sources":["../../src/requests/cancel-pickup-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAU7C,kEAAkE;AAClE,MAAa,mBAAoB,SAAQ,0BAAW;IAClD,YAAY,CAAsB;IAClC,QAAQ,CAAyB;IACjC,oBAAoB,CAAuB;IAC3C,OAAO,CAAwB;IAC/B,cAAc,CAAyB;IACvC,cAAc,CAAkB;IAChC,iBAAiB,CAA6B;CAC/C;AARD,kDAQC"}