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

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

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

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

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddressBase = void 0;
+class AddressBase {
+    /** @description The full name of the contact contact associated with the address */
+    name;
+    /** @description The first name of the contact associated with the address */
+    first_name;
+    /** @description The last name of the contact associated with the address */
+    last_name;
+    /** @description The email of the contact associated with the address */
+    email;
+    /** @description The phone number of the contact associated with the address (No Newline Characters) */
+    phone_number;
+    /** @description The name of the company associated with this address (No Newline Characters) max length 100 characters */
+    company_name;
+    /** @description The address lines of the address (No Newline Characters) max length 100 characters */
+    address_lines;
+    /** @description City or locality (No Newline Characters) */
+    city_locality;
+    /** @description State or province (No Newline Characters) */
+    state_province;
+    /** @description Zip or postal code (No Newline Characters) */
+    postal_code;
+    /** @description ISO 3166-1 two-letter country code max length 2 characters  */
+    country_code;
+    /** @description Whether the address is residential or commercial */
+    address_residential_indicator;
+    /** @description Whether the country of the shipment address is a member of the EU */
+    is_eu;
+    /** @description Additional metadata provided for specific requests */
+    address_metadata;
+    /** @description Instructions to help the carrier navigate to the address */
+    instructions;
+}
+exports.AddressBase = AddressBase;
+//# sourceMappingURL=address-base.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"address-base.js","sourceRoot":"","sources":["../../../src/models/addresses/address-base.ts"],"names":[],"mappings":";;;AAEA,MAAa,WAAW;IACtB,oFAAoF;IACpF,IAAI,CAAU;IACd,6EAA6E;IAC7E,UAAU,CAAU;IACpB,4EAA4E;IAC5E,SAAS,CAAU;IACnB,wEAAwE;IACxE,KAAK,CAAU;IACf,uGAAuG;IACvG,YAAY,CAAU;IACtB,0HAA0H;IAC1H,YAAY,CAAU;IACtB,sGAAsG;IACtG,aAAa,CAAY;IACzB,4DAA4D;IAC5D,aAAa,CAAU;IACvB,6DAA6D;IAC7D,cAAc,CAAU;IACxB,8DAA8D;IAC9D,WAAW,CAAU;IACrB,+EAA+E;IAC/E,YAAY,CAAU;IACtB,oEAAoE;IACpE,6BAA6B,CAA+B;IAC5D,qFAAqF;IACrF,KAAK,CAAW;IAChB,sEAAsE;IACtE,gBAAgB,CAA6B;IAC7C,4EAA4E;IAC5E,YAAY,CAAU;CACvB;AA/BD,kCA+BC"}

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

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

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddressResidentialIndicatorSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const address_residential_indicator_1 = require("./address-residential-indicator");
+exports.AddressResidentialIndicatorSchema = joi_1.default.string().valid(...Object.values(address_residential_indicator_1.AddressResidentialIndicator));
+//# sourceMappingURL=address-residential-indicator-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"address-residential-indicator-schema.js","sourceRoot":"","sources":["../../../src/models/addresses/address-residential-indicator-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,mFAA8E;AAEjE,QAAA,iCAAiC,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CACjE,GAAG,MAAM,CAAC,MAAM,CAAC,2DAA2B,CAAC,CAC9C,CAAC"}

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

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

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

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

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

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

package/lib/models/addresses/geolocation-item.d.ts

@@ -0,0 +1,12 @@
+/** @description Geolocation additional information for an address. */
+export declare class GeolocationItem {
+    /** @description Specifies the supported geolocation types. */
+    type?: GeolocationType;
+    /** @description The geolocation value. */
+    value?: string;
+}
+/** @description Supported geolocation types. */
+export declare enum GeolocationType {
+    /** @description what3words field to help identify the location */
+    what3words = "what3words"
+}

package/lib/models/addresses/geolocation-item.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeolocationType = exports.GeolocationItem = void 0;
+/** @description Geolocation additional information for an address. */
+class GeolocationItem {
+    /** @description Specifies the supported geolocation types. */
+    type;
+    /** @description The geolocation value. */
+    value;
+}
+exports.GeolocationItem = GeolocationItem;
+/** @description Supported geolocation types. */
+var GeolocationType;
+(function (GeolocationType) {
+    /** @description what3words field to help identify the location */
+    GeolocationType["what3words"] = "what3words";
+})(GeolocationType || (exports.GeolocationType = GeolocationType = {}));
+//# sourceMappingURL=geolocation-item.js.map

package/lib/models/addresses/geolocation-item.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"geolocation-item.js","sourceRoot":"","sources":["../../../src/models/addresses/geolocation-item.ts"],"names":[],"mappings":";;;AAAA,sEAAsE;AACtE,MAAa,eAAe;IAC1B,8DAA8D;IAC9D,IAAI,CAAmB;IACvB,0CAA0C;IAC1C,KAAK,CAAU;CAChB;AALD,0CAKC;AAED,gDAAgD;AAChD,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,kEAAkE;IAClE,4CAAyB,CAAA;AAC3B,CAAC,EAHW,eAAe,+BAAf,eAAe,QAG1B"}

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

@@ -0,0 +1,7 @@
+export * from './address-base';
+export * from './address-residential-indicator';
+export * from './ship-from';
+export * from './ship-from-display';
+export * from './ship-to';
+export * from './pudo-location';
+export * from './pudo-location-schema';

package/lib/models/addresses/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./address-base"), exports);
+tslib_1.__exportStar(require("./address-residential-indicator"), exports);
+tslib_1.__exportStar(require("./ship-from"), exports);
+tslib_1.__exportStar(require("./ship-from-display"), exports);
+tslib_1.__exportStar(require("./ship-to"), exports);
+tslib_1.__exportStar(require("./pudo-location"), exports);
+tslib_1.__exportStar(require("./pudo-location-schema"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/addresses/index.ts"],"names":[],"mappings":";;;AAAA,yDAA+B;AAC/B,0EAAgD;AAChD,sDAA4B;AAC5B,8DAAoC;AACpC,oDAA0B;AAC1B,0DAAgC;AAChC,iEAAuC"}

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

@@ -0,0 +1,3 @@
+import { AddressBase } from './address-base';
+export declare class PickupAddress extends AddressBase {
+}

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PickupAddress = void 0;
+const address_base_1 = require("./address-base");
+class PickupAddress extends address_base_1.AddressBase {
+}
+exports.PickupAddress = PickupAddress;
+//# sourceMappingURL=pickup-address.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pickup-address.js","sourceRoot":"","sources":["../../../src/models/addresses/pickup-address.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAE7C,MAAa,aAAc,SAAQ,0BAAW;CAAG;AAAjD,sCAAiD"}

package/lib/models/addresses/pudo-location-schema.d.ts

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

package/lib/models/addresses/pudo-location-schema.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PudoLocationSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const address_base_schema_1 = require("./address-base-schema");
+exports.PudoLocationSchema = address_base_schema_1.AddressBaseSchema.keys({
+    carrier_code: joi_1.default.string().optional(),
+    location_id: joi_1.default.string().optional(),
+});
+//# sourceMappingURL=pudo-location-schema.js.map

package/lib/models/addresses/pudo-location-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pudo-location-schema.js","sourceRoot":"","sources":["../../../src/models/addresses/pudo-location-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,+DAA0D;AAE7C,QAAA,kBAAkB,GAAG,uCAAiB,CAAC,IAAI,CAAC;IACvD,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC"}

package/lib/models/addresses/pudo-location.d.ts

@@ -0,0 +1,8 @@
+import { AddressBase } from './address-base';
+/** @description Pickup/Dropoff location used by carriers */
+export declare class PudoLocation extends AddressBase {
+    /** @description Standardized carrier code the location id belongs to */
+    carrier_code?: string;
+    /** @description Location id needed to look up the location */
+    location_id?: string;
+}

package/lib/models/addresses/pudo-location.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PudoLocation = void 0;
+const address_base_1 = require("./address-base");
+/** @description Pickup/Dropoff location used by carriers */
+class PudoLocation extends address_base_1.AddressBase {
+    /** @description Standardized carrier code the location id belongs to */
+    carrier_code;
+    /** @description Location id needed to look up the location */
+    location_id;
+}
+exports.PudoLocation = PudoLocation;
+//# sourceMappingURL=pudo-location.js.map

package/lib/models/addresses/pudo-location.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pudo-location.js","sourceRoot":"","sources":["../../../src/models/addresses/pudo-location.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAE7C,4DAA4D;AAC5D,MAAa,YAAa,SAAQ,0BAAW;IAC3C,wEAAwE;IACxE,YAAY,CAAU;IACtB,8DAA8D;IAC9D,WAAW,CAAU;CACtB;AALD,oCAKC"}

package/lib/models/addresses/service-point-address.d.ts

@@ -0,0 +1,7 @@
+import { LatLong } from '../tracking/lat-long';
+import { AddressBase } from './address-base';
+/** @description The basic address type related to service points */
+export declare class ServicePointAddress extends AddressBase {
+    /** @description Geographical location */
+    geo?: LatLong;
+}

package/lib/models/addresses/service-point-address.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServicePointAddress = void 0;
+const address_base_1 = require("./address-base");
+/** @description The basic address type related to service points */
+class ServicePointAddress extends address_base_1.AddressBase {
+    /** @description Geographical location */
+    geo;
+}
+exports.ServicePointAddress = ServicePointAddress;
+//# sourceMappingURL=service-point-address.js.map

package/lib/models/addresses/service-point-address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-point-address.js","sourceRoot":"","sources":["../../../src/models/addresses/service-point-address.ts"],"names":[],"mappings":";;;AACA,iDAA6C;AAE7C,oEAAoE;AACpE,MAAa,mBAAoB,SAAQ,0BAAW;IAClD,yCAAyC;IACzC,GAAG,CAAW;CACf;AAHD,kDAGC"}

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

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

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShipFromDisplay = void 0;
+const address_base_1 = require("./address-base");
+/** @description The address that should be displayed on the label as the ship from location */
+class ShipFromDisplay extends address_base_1.AddressBase {
+}
+exports.ShipFromDisplay = ShipFromDisplay;
+//# sourceMappingURL=ship-from-display.js.map

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

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

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

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

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShipFrom = void 0;
+const address_base_1 = require("./address-base");
+/** @description The address for where the shipment will be shipped from */
+class ShipFrom extends address_base_1.AddressBase {
+    /** @description Tax IDs associated with the exporter */
+    tax_identifiers;
+}
+exports.ShipFrom = ShipFrom;
+//# sourceMappingURL=ship-from.js.map

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

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

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

@@ -0,0 +1,10 @@
+import { AddressBase } from './address-base';
+import { TaxIdentifier } from '../taxes/tax-identifier';
+import { GeolocationItem } from './geolocation-item';
+/** @description The address that a shipment will be delivered to */
+export declare class ShipTo extends AddressBase {
+    /** @description Tax IDs associated with the consignee */
+    tax_identifiers?: TaxIdentifier[];
+    /** @description List of Geolocation objects to help identify the location. */
+    geolocation?: GeolocationItem[];
+}

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShipTo = void 0;
+const address_base_1 = require("./address-base");
+/** @description The address that a shipment will be delivered to */
+class ShipTo extends address_base_1.AddressBase {
+    /** @description Tax IDs associated with the consignee */
+    tax_identifiers;
+    /** @description List of Geolocation objects to help identify the location. */
+    geolocation;
+}
+exports.ShipTo = ShipTo;
+//# sourceMappingURL=ship-to.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ship-to.js","sourceRoot":"","sources":["../../../src/models/addresses/ship-to.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAI7C,oEAAoE;AACpE,MAAa,MAAO,SAAQ,0BAAW;IACrC,yDAAyD;IACzD,eAAe,CAAmB;IAClC,8EAA8E;IAC9E,WAAW,CAAqB;CACjC;AALD,wBAKC"}

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

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

package/lib/models/advanced-options-schema.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdvancedOptionsSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const currency_schema_1 = require("./currency-schema");
+exports.AdvancedOptionsSchema = joi_1.default.object({
+    contains_alcohol: joi_1.default.boolean().optional(),
+    no_postage: joi_1.default.boolean().optional(),
+    nonmachineable: joi_1.default.boolean().optional(),
+    bill_duties_to_sender: joi_1.default.boolean().optional(),
+    saturday_delivery: joi_1.default.boolean().optional(),
+    tip: currency_schema_1.CurrencySchema.optional(),
+}).pattern(/.*/, joi_1.default.any());
+//# sourceMappingURL=advanced-options-schema.js.map

package/lib/models/advanced-options-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"advanced-options-schema.js","sourceRoot":"","sources":["../../src/models/advanced-options-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,uDAAmD;AAEtC,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,gBAAgB,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC1C,UAAU,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACpC,cAAc,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACxC,qBAAqB,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/C,iBAAiB,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC3C,GAAG,EAAE,gCAAc,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,aAAG,CAAC,GAAG,EAAE,CAAC,CAAC"}

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

@@ -0,0 +1,49 @@
+import { CollectOnDelivery } from './collect-on-delivery';
+import { Currency } from './currency';
+import { DangerousGoodsContact } from './dangerous-good/dangerous-goods-contact';
+import { WindsorFrameworkDetails } from './windsor-framework/windsor_framework_details';
+import { AccessibilityTypes } from './accessibility-types';
+import { Signatory } from './signatory';
+import { RegulationLevelTypes } from './dangerous-good/regulation-level-types';
+import { TransportMeanTypes } from './dangerous-good/transport-mean-types';
+/** @description Basic structure for shipping options */
+export declare class AdvancedOptions {
+    /** @description Whether the shipment contains alcohol */
+    contains_alcohol?: boolean;
+    /** @description Whether the shipment does not require postage */
+    no_postage?: boolean;
+    /** @description Whether the shipment can be processed by machine */
+    nonmachineable?: boolean;
+    /** @description Whether the shipment duties should be billed to the sender */
+    bill_duties_to_sender?: boolean;
+    /** @description Whether Saturday delivery is permissible  */
+    saturday_delivery?: boolean;
+    /** @description Amount to be paid to the driver, used for local delivery and courier services */
+    tip?: Currency;
+    /** @description Describes whether Additional Handling is requested for the shipment  */
+    additional_handling?: boolean;
+    /** @description Describes details for Collect on Delivery (COD) if requested for the shipment */
+    collect_on_delivery?: CollectOnDelivery;
+    /** @description Whether client is requesting the ability to upload documents like commercial invoice after the shipment has been processed */
+    own_document_upload?: boolean;
+    /** @description Indicates if the Dangerous goods are present in the shipment. */
+    dangerous_goods?: boolean;
+    /** @description Contact information for Dangerous goods */
+    dangerous_goods_contact?: DangerousGoodsContact;
+    /** @description Describes the transport of dangerous goods that is restricted to Limited Quantities of Dangerous Goods only */
+    limited_quantity?: boolean;
+    /** @description Any other custom shipping options */
+    event_notification?: boolean;
+    /** @description Any other custom shipping options */
+    windsor_framework_details?: WindsorFrameworkDetails;
+    /** @description Identifies whatever the product being shipped is accessible or inaccessible during delivery.*/
+    accessibility?: AccessibilityTypes;
+    /** @description Specify the name, title and place of the signatory responsible for the dangerous goods shipment. */
+    signatory?: Signatory;
+    /** @description Types of regulation level defined for dangerous good */
+    regulation_level?: RegulationLevelTypes;
+    /** @description Transportation means through which the dangerous goods are transported */
+    transport_mean?: TransportMeanTypes;
+    /** @description Indicates whether the recipient should be notified of events related to the shipment. */
+    [key: string]: any;
+}

package/lib/models/advanced-options.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdvancedOptions = void 0;
+/** @description Basic structure for shipping options */
+class AdvancedOptions {
+    /** @description Whether the shipment contains alcohol */
+    contains_alcohol;
+    /** @description Whether the shipment does not require postage */
+    no_postage;
+    /** @description Whether the shipment can be processed by machine */
+    nonmachineable;
+    /** @description Whether the shipment duties should be billed to the sender */
+    bill_duties_to_sender;
+    /** @description Whether Saturday delivery is permissible  */
+    saturday_delivery;
+    /** @description Amount to be paid to the driver, used for local delivery and courier services */
+    tip;
+    /** @description Describes whether Additional Handling is requested for the shipment  */
+    additional_handling;
+    /** @description Describes details for Collect on Delivery (COD) if requested for the shipment */
+    collect_on_delivery;
+    /** @description Whether client is requesting the ability to upload documents like commercial invoice after the shipment has been processed */
+    own_document_upload;
+    /** @description Indicates if the Dangerous goods are present in the shipment. */
+    dangerous_goods;
+    /** @description Contact information for Dangerous goods */
+    dangerous_goods_contact;
+    /** @description Describes the transport of dangerous goods that is restricted to Limited Quantities of Dangerous Goods only */
+    limited_quantity;
+    /** @description Any other custom shipping options */
+    event_notification;
+    /** @description Any other custom shipping options */
+    windsor_framework_details;
+    /** @description Identifies whatever the product being shipped is accessible or inaccessible during delivery.*/
+    accessibility;
+    /** @description Specify the name, title and place of the signatory responsible for the dangerous goods shipment. */
+    signatory;
+    /** @description Types of regulation level defined for dangerous good */
+    regulation_level;
+    /** @description Transportation means through which the dangerous goods are transported */
+    transport_mean;
+}
+exports.AdvancedOptions = AdvancedOptions;
+//# sourceMappingURL=advanced-options.js.map

package/lib/models/advanced-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"advanced-options.js","sourceRoot":"","sources":["../../src/models/advanced-options.ts"],"names":[],"mappings":";;;AASA,wDAAwD;AACxD,MAAa,eAAe;IAC1B,yDAAyD;IACzD,gBAAgB,CAAW;IAC3B,iEAAiE;IACjE,UAAU,CAAW;IACrB,oEAAoE;IACpE,cAAc,CAAW;IACzB,8EAA8E;IAC9E,qBAAqB,CAAW;IAChC,6DAA6D;IAC7D,iBAAiB,CAAW;IAC5B,iGAAiG;IACjG,GAAG,CAAY;IACf,wFAAwF;IACxF,mBAAmB,CAAW;IAC9B,iGAAiG;IACjG,mBAAmB,CAAqB;IACxC,8IAA8I;IAC9I,mBAAmB,CAAW;IAC9B,iFAAiF;IACjF,eAAe,CAAW;IAC1B,2DAA2D;IAC3D,uBAAuB,CAAyB;IAChD,+HAA+H;IAC/H,gBAAgB,CAAW;IAC3B,qDAAqD;IACrD,kBAAkB,CAAW;IAC7B,qDAAqD;IACrD,yBAAyB,CAA2B;IACpD,+GAA+G;IAC/G,aAAa,CAAsB;IACnC,oHAAoH;IACpH,SAAS,CAAa;IACtB,wEAAwE;IACxE,gBAAgB,CAAwB;IACxC,0FAA0F;IAC1F,cAAc,CAAsB;CAGrC;AAvCD,0CAuCC"}

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

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

package/lib/models/authorization-schema.js

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

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

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

package/lib/models/authorization.d.ts

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

package/lib/models/authorization.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Authorization = void 0;
+class Authorization {
+    /** @description The access token used to authorize the request */
+    access_token;
+    /** @description Optional - any additional information required to authorize the request */
+    connection_context;
+}
+exports.Authorization = Authorization;
+//# sourceMappingURL=authorization.js.map

package/lib/models/authorization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorization.js","sourceRoot":"","sources":["../../src/models/authorization.ts"],"names":[],"mappings":";;;AAAA,MAAa,aAAa;IACxB,kEAAkE;IAClE,YAAY,CAAU;IACtB,2FAA2F;IAC3F,kBAAkB,CAAO;CAC1B;AALD,sCAKC"}

package/lib/models/bill-to.d.ts

@@ -0,0 +1,14 @@
+import { AddressBase } from './addresses';
+import { BillToParty } from './billing';
+/**
+ * @description Bill to is a generic object used for billing a part of the shipment, duties, taxes, or otherwise to a party
+        other than the shipper (the shipper is considered the default party responsible). Ref: BillTo extends AddressBase.
+        since address fields are often required when associating billing to
+        another account.  Additionally, this allows for a contact to be specified, if necessary.
+ */
+export declare class BillTo extends AddressBase {
+    /** @description The bill_to_party mentions the type of billing option*/
+    bill_to_party?: BillToParty;
+    /** @description Specified if there is an account number associated with the Bill To Party, and the Bill To Party is not the account holder. */
+    account_number?: string;
+}

package/lib/models/bill-to.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillTo = void 0;
+const addresses_1 = require("./addresses");
+/**
+ * @description Bill to is a generic object used for billing a part of the shipment, duties, taxes, or otherwise to a party
+        other than the shipper (the shipper is considered the default party responsible). Ref: BillTo extends AddressBase.
+        since address fields are often required when associating billing to
+        another account.  Additionally, this allows for a contact to be specified, if necessary.
+ */
+class BillTo extends addresses_1.AddressBase {
+    /** @description The bill_to_party mentions the type of billing option*/
+    bill_to_party;
+    /** @description Specified if there is an account number associated with the Bill To Party, and the Bill To Party is not the account holder. */
+    account_number;
+}
+exports.BillTo = BillTo;
+//# sourceMappingURL=bill-to.js.map

package/lib/models/bill-to.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bill-to.js","sourceRoot":"","sources":["../../src/models/bill-to.ts"],"names":[],"mappings":";;;AAAA,2CAA0C;AAG1C;;;;;GAKG;AACH,MAAa,MAAO,SAAQ,uBAAW;IACrC,wEAAwE;IACxE,aAAa,CAAe;IAC5B,+IAA+I;IAC/I,cAAc,CAAU;CACzB;AALD,wBAKC"}

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"billing-categories-schema.js","sourceRoot":"","sources":["../../../src/models/billing/billing-categories-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,6DAAyD;AAE5C,QAAA,uBAAuB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,sCAAiB,CAAC,CAAC,CAAC"}