@shipengine/connect-carrier-api 4.26.1 → 4.26.3

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

@@ -3,21 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AddressBaseSchema = void 0;
 const tslib_1 = require("tslib");
 const joi_1 = tslib_1.__importDefault(require("joi"));
-exports.AddressBaseSchema = joi_1.default.object({
-    name: joi_1.default.string().optional().empty(),
-    first_name: joi_1.default.string().optional().empty(),
-    last_name: joi_1.default.string().optional().empty(),
-    email: joi_1.default.string().email().optional().empty(),
-    phone_number: joi_1.default.string().optional().empty(),
-    company_name: joi_1.default.string().optional().empty(),
-    address_lines: joi_1.default.array().items(joi_1.default.string()).optional(),
-    city_locality: joi_1.default.string().optional().empty(),
-    state_province: joi_1.default.string().optional().empty(),
+const address_common_schema_1 = require("./address-common-schema");
+exports.AddressBaseSchema = address_common_schema_1.AddressCommonSchema.keys({
     postal_code: joi_1.default.string().required(),
     country_code: joi_1.default.string().required(),
-    address_residential_indicator: joi_1.default.string().optional().empty(),
-    is_eu: joi_1.default.boolean().optional(),
-    address_metadata: joi_1.default.object().optional().empty(),
-    instructions: joi_1.default.string().optional().empty(),
 });
 //# sourceMappingURL=address-base-schema.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"address-base-schema.js","sourceRoot":"","sources":["../../../src/models/addresses/address-base-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAET,QAAA,iBAAiB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC1C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3C,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC1C,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,aAAa,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzD,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9C,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC/C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,6BAA6B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9D,KAAK,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACjD,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CAC9C,CAAC,CAAC"}
+{"version":3,"file":"address-base-schema.js","sourceRoot":"","sources":["../../../src/models/addresses/address-base-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,mEAA8D;AAEjD,QAAA,iBAAiB,GAAG,2CAAmB,CAAC,IAAI,CAAC;IACxD,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACtC,CAAC,CAAC"}

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

@@ -1,35 +1,7 @@
-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;
+import { AddressCommon } from './address-common';
+export declare class AddressBase extends AddressCommon {
     /** @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

@@ -1,37 +1,12 @@
 "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;
+const address_common_1 = require("./address-common");
+class AddressBase extends address_common_1.AddressCommon {
     /** @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

@@ -1 +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"}
+{"version":3,"file":"address-base.js","sourceRoot":"","sources":["../../../src/models/addresses/address-base.ts"],"names":[],"mappings":";;;AAAA,qDAAiD;AAEjD,MAAa,WAAY,SAAQ,8BAAa;IAC5C,8DAA8D;IAC9D,WAAW,CAAU;IACrB,+EAA+E;IAC/E,YAAY,CAAU;CACvB;AALD,kCAKC"}

package/lib/models/addresses/address-common-schema.d.ts

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

package/lib/models/addresses/address-common-schema.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddressCommonSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+exports.AddressCommonSchema = joi_1.default.object({
+    name: joi_1.default.string().optional().empty(),
+    first_name: joi_1.default.string().optional().empty(),
+    last_name: joi_1.default.string().optional().empty(),
+    email: joi_1.default.string().email().optional().empty(),
+    phone_number: joi_1.default.string().optional().empty(),
+    company_name: joi_1.default.string().optional().empty(),
+    address_lines: joi_1.default.array().items(joi_1.default.string()).optional(),
+    city_locality: joi_1.default.string().optional().empty(),
+    state_province: joi_1.default.string().optional().empty(),
+    address_residential_indicator: joi_1.default.string().optional().empty(),
+    is_eu: joi_1.default.boolean().optional(),
+    address_metadata: joi_1.default.object().optional().empty(),
+    instructions: joi_1.default.string().optional().empty(),
+});
+//# sourceMappingURL=address-common-schema.js.map

package/lib/models/addresses/address-common-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"address-common-schema.js","sourceRoot":"","sources":["../../../src/models/addresses/address-common-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAET,QAAA,mBAAmB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC5C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACrC,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3C,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC1C,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,aAAa,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzD,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9C,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC/C,6BAA6B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9D,KAAK,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACjD,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CAC9C,CAAC,CAAC"}

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

@@ -0,0 +1,31 @@
+import { AddressResidentialIndicator } from './address-residential-indicator';
+export declare class AddressCommon {
+    /** @description The full name of the 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 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-common.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddressCommon = void 0;
+class AddressCommon {
+    /** @description The full name of the 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 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.AddressCommon = AddressCommon;
+//# sourceMappingURL=address-common.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"address-common.js","sourceRoot":"","sources":["../../../src/models/addresses/address-common.ts"],"names":[],"mappings":";;;AAEA,MAAa,aAAa;IACxB,4EAA4E;IAC5E,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,oEAAoE;IACpE,6BAA6B,CAA+B;IAC5D,qFAAqF;IACrF,KAAK,CAAW;IAChB,sEAAsE;IACtE,gBAAgB,CAA6B;IAC7C,4EAA4E;IAC5E,YAAY,CAAU;CACvB;AA3BD,sCA2BC"}

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

@@ -1,4 +1,5 @@
 export * from './address-base';
+export * from './address-common';
 export * from './address-residential-indicator';
 export * from './ship-from';
 export * from './ship-from-display';

package/lib/models/addresses/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./address-base"), exports);
+tslib_1.__exportStar(require("./address-common"), exports);
 tslib_1.__exportStar(require("./address-residential-indicator"), exports);
 tslib_1.__exportStar(require("./ship-from"), exports);
 tslib_1.__exportStar(require("./ship-from-display"), exports);

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

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

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

@@ -1,8 +1,21 @@
-import { AddressBase } from './address-base';
+import { AddressCommon } from './address-common';
 /** @description Pickup/Dropoff location used by carriers */
-export declare class PudoLocation extends AddressBase {
+export declare class PudoLocation extends AddressCommon {
+    /**
+     * @description Zip or postal code (No Newline Characters)
+     * Required if `location_id` is not provided
+     */
+    postal_code?: string;
+    /**
+     * @description ISO 3166-1 two-letter country code max length 2 characters
+     * Required if `location_id` is not provided
+     */
+    country_code?: string;
     /** @description Standardized carrier code the location id belongs to */
     carrier_code?: string;
-    /** @description Location id needed to look up the location */
+    /**
+     * @description Location id needed to look up the location.
+     * Required if `postal_code` or `country_code` is not provided.
+     */
     location_id?: string;
 }

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

@@ -1,12 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PudoLocation = void 0;
-const address_base_1 = require("./address-base");
+const address_common_1 = require("./address-common");
 /** @description Pickup/Dropoff location used by carriers */
-class PudoLocation extends address_base_1.AddressBase {
+class PudoLocation extends address_common_1.AddressCommon {
+    /**
+     * @description Zip or postal code (No Newline Characters)
+     * Required if `location_id` is not provided
+     */
+    postal_code;
+    /**
+     * @description ISO 3166-1 two-letter country code max length 2 characters
+     * Required if `location_id` is not provided
+     */
+    country_code;
     /** @description Standardized carrier code the location id belongs to */
     carrier_code;
-    /** @description Location id needed to look up the location */
+    /**
+     * @description Location id needed to look up the location.
+     * Required if `postal_code` or `country_code` is not provided.
+     */
     location_id;
 }
 exports.PudoLocation = PudoLocation;

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

@@ -1 +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"}
+{"version":3,"file":"pudo-location.js","sourceRoot":"","sources":["../../../src/models/addresses/pudo-location.ts"],"names":[],"mappings":";;;AAAA,qDAAiD;AAEjD,4DAA4D;AAC5D,MAAa,YAAa,SAAQ,8BAAa;IAC7C;;;OAGG;IACH,WAAW,CAAU;IACrB;;;OAGG;IACH,YAAY,CAAU;IACtB,wEAAwE;IACxE,YAAY,CAAU;IACtB;;;OAGG;IACH,WAAW,CAAU;CACtB;AAlBD,oCAkBC"}

package/lib/models/documents/uploads/document-upload-shipment.d.ts

@@ -0,0 +1,9 @@
+/** @description Shipment information relating to an uploaded document */
+export declare class DocumentUploadShipment {
+    /** @description The shipment datetime */
+    datetime: string;
+    /** @description The origin country code */
+    origin_country_code: string;
+    /** @description The destination country code */
+    destination_country_code: string;
+}

package/lib/models/documents/uploads/document-upload-shipment.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentUploadShipment = void 0;
+/** @description Shipment information relating to an uploaded document */
+class DocumentUploadShipment {
+    /** @description The shipment datetime */
+    datetime;
+    /** @description The origin country code */
+    origin_country_code;
+    /** @description The destination country code */
+    destination_country_code;
+}
+exports.DocumentUploadShipment = DocumentUploadShipment;
+//# sourceMappingURL=document-upload-shipment.js.map

package/lib/models/documents/uploads/document-upload-shipment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-upload-shipment.js","sourceRoot":"","sources":["../../../../src/models/documents/uploads/document-upload-shipment.ts"],"names":[],"mappings":";;;AAAA,yEAAyE;AACzE,MAAa,sBAAsB;IACjC,yCAAyC;IACzC,QAAQ,CAAU;IAClB,2CAA2C;IAC3C,mBAAmB,CAAU;IAC7B,gDAAgD;IAChD,wBAAwB,CAAU;CACnC;AAPD,wDAOC"}

package/lib/models/documents/uploads/index.d.ts

@@ -1,4 +1,5 @@
 export * from './document-upload-format';
 export * from './document-upload-format-schema';
+export * from './document-upload-shipment';
 export * from './document-upload-type';
 export * from './document-upload-type-schema';

package/lib/models/documents/uploads/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./document-upload-format"), exports);
 tslib_1.__exportStar(require("./document-upload-format-schema"), exports);
+tslib_1.__exportStar(require("./document-upload-shipment"), exports);
 tslib_1.__exportStar(require("./document-upload-type"), exports);
 tslib_1.__exportStar(require("./document-upload-type-schema"), exports);
 //# sourceMappingURL=index.js.map

package/lib/models/documents/uploads/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/documents/uploads/index.ts"],"names":[],"mappings":";;;AAAA,mEAAyC;AACzC,0EAAgD;AAChD,iEAAuC;AACvC,wEAA8C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/documents/uploads/index.ts"],"names":[],"mappings":";;;AAAA,mEAAyC;AACzC,0EAAgD;AAChD,qEAA2C;AAC3C,iEAAuC;AACvC,wEAA8C"}

package/lib/requests/upload-document-request.d.ts

@@ -1,5 +1,5 @@
 import { BaseRequest } from './base-request';
-import { Identifier, DocumentUploadFormat, DocumentUploadType } from '../models';
+import { Identifier, DocumentUploadFormat, DocumentUploadShipment, DocumentUploadType } from '../models';
 /**
  * A request to upload a document for a shipment.
  */
@@ -18,4 +18,6 @@ export declare class UploadDocumentRequest extends BaseRequest {
     tracking_number: string;
     /** @description Non-tracking alternative ids associated with this shipment */
     alternative_identifiers?: Identifier[];
+    /** @description Shipment information relating to an uploaded document */
+    shipment?: DocumentUploadShipment;
 }

package/lib/requests/upload-document-request.js

@@ -20,6 +20,8 @@ class UploadDocumentRequest extends base_request_1.BaseRequest {
     tracking_number;
     /** @description Non-tracking alternative ids associated with this shipment */
     alternative_identifiers;
+    /** @description Shipment information relating to an uploaded document */
+    shipment;
 }
 exports.UploadDocumentRequest = UploadDocumentRequest;
 //# sourceMappingURL=upload-document-request.js.map

package/lib/requests/upload-document-request.js.map

@@ -1 +1 @@
-{"version":3,"file":"upload-document-request.js","sourceRoot":"","sources":["../../src/requests/upload-document-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAG7C;;GAEG;AACH,MAAa,qBAAsB,SAAQ,0BAAW;IACpD,mCAAmC;IACnC,WAAW,CAAU;IACrB,4CAA4C;IAC5C,aAAa,CAAsB;IACnC,8CAA8C;IAC9C,eAAe,CAAwB;IACvC,iCAAiC;IACjC,SAAS,CAAU;IACnB,gCAAgC;IAChC,QAAQ,CAAU;IAClB,iEAAiE;IACjE,eAAe,CAAU;IACzB,8EAA8E;IAC9E,uBAAuB,CAAgB;CACxC;AAfD,sDAeC"}
+{"version":3,"file":"upload-document-request.js","sourceRoot":"","sources":["../../src/requests/upload-document-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAQ7C;;GAEG;AACH,MAAa,qBAAsB,SAAQ,0BAAW;IACpD,mCAAmC;IACnC,WAAW,CAAU;IACrB,4CAA4C;IAC5C,aAAa,CAAsB;IACnC,8CAA8C;IAC9C,eAAe,CAAwB;IACvC,iCAAiC;IACjC,SAAS,CAAU;IACnB,gCAAgC;IAChC,QAAQ,CAAU;IAClB,iEAAiE;IACjE,eAAe,CAAU;IACzB,8EAA8E;IAC9E,uBAAuB,CAAgB;IACvC,yEAAyE;IACzE,QAAQ,CAA0B;CACnC;AAjBD,sDAiBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.26.1",
+  "version": "4.26.3",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",

package/spec.json

@@ -2428,6 +2428,28 @@
         ],
         "type": "string"
       },
+      "DocumentUploadShipment": {
+        "type": "object",
+        "properties": {
+          "datetime": {
+            "type": "string",
+            "description": "The shipment datetime",
+            "format": "date-time"
+          },
+          "origin_country_code": {
+            "type": "string",
+            "description": "The origin country code.",
+            "nullable": true
+          },
+          "destination_country_code": {
+            "type": "string",
+            "description": "The destination country code.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "Shipment information relating to an uploaded document."
+      },
       "DocumentUploadType": {
         "enum": [
           "commercial_invoice",
@@ -3941,6 +3963,16 @@
           }
         ],
         "properties": {
+          "postal_code": {
+            "type": "string",
+            "description": "The postal code of the address.\r\nNot required when location_id is provided.",
+            "nullable": true
+          },
+          "country_code": {
+            "type": "string",
+            "description": "The two character country code of the shipment address.\r\nNot required when location_id is provided.",
+            "nullable": true
+          },
           "carrier_code": {
             "type": "string",
             "description": "Standardized carrier code the location ID belongs to.",
@@ -5602,6 +5634,9 @@
             },
             "description": "Alternative identifiers associated with this package",
             "nullable": true
+          },
+          "shipment": {
+            "$ref": "#/components/schemas/DocumentUploadShipment"
           }
         },
         "additionalProperties": false,

package/src/models/addresses/address-base-schema.ts

@@ -1,19 +1,7 @@
 import Joi from 'joi';
+import { AddressCommonSchema } from './address-common-schema';
 
-export const AddressBaseSchema = Joi.object({
-  name: Joi.string().optional().empty(),
-  first_name: Joi.string().optional().empty(),
-  last_name: Joi.string().optional().empty(),
-  email: Joi.string().email().optional().empty(),
-  phone_number: Joi.string().optional().empty(),
-  company_name: Joi.string().optional().empty(),
-  address_lines: Joi.array().items(Joi.string()).optional(),
-  city_locality: Joi.string().optional().empty(),
-  state_province: Joi.string().optional().empty(),
+export const AddressBaseSchema = AddressCommonSchema.keys({
   postal_code: Joi.string().required(),
   country_code: Joi.string().required(),
-  address_residential_indicator: Joi.string().optional().empty(),
-  is_eu: Joi.boolean().optional(),
-  address_metadata: Joi.object().optional().empty(),
-  instructions: Joi.string().optional().empty(),
 });

package/src/models/addresses/address-base.ts

@@ -1,34 +1,8 @@
-import { AddressResidentialIndicator } from './address-residential-indicator';
+import { AddressCommon } from './address-common';
 
-export 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;
+export class AddressBase extends AddressCommon {
   /** @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/src/models/addresses/address-common-schema.ts

@@ -0,0 +1,17 @@
+import Joi from 'joi';
+
+export const AddressCommonSchema = Joi.object({
+  name: Joi.string().optional().empty(),
+  first_name: Joi.string().optional().empty(),
+  last_name: Joi.string().optional().empty(),
+  email: Joi.string().email().optional().empty(),
+  phone_number: Joi.string().optional().empty(),
+  company_name: Joi.string().optional().empty(),
+  address_lines: Joi.array().items(Joi.string()).optional(),
+  city_locality: Joi.string().optional().empty(),
+  state_province: Joi.string().optional().empty(),
+  address_residential_indicator: Joi.string().optional().empty(),
+  is_eu: Joi.boolean().optional(),
+  address_metadata: Joi.object().optional().empty(),
+  instructions: Joi.string().optional().empty(),
+});

package/src/models/addresses/address-common.ts

@@ -0,0 +1,30 @@
+import { AddressResidentialIndicator } from './address-residential-indicator';
+
+export class AddressCommon {
+  /** @description The full name of the 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 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/src/models/addresses/index.ts

@@ -1,4 +1,5 @@
 export * from './address-base';
+export * from './address-common';
 export * from './address-residential-indicator';
 export * from './ship-from';
 export * from './ship-from-display';

package/src/models/addresses/pudo-location.ts

@@ -1,9 +1,22 @@
-import { AddressBase } from './address-base';
+import { AddressCommon } from './address-common';
 
 /** @description Pickup/Dropoff location used by carriers */
-export class PudoLocation extends AddressBase {
+export class PudoLocation extends AddressCommon {
+  /**
+   * @description Zip or postal code (No Newline Characters)
+   * Required if `location_id` is not provided
+   */
+  postal_code?: string;
+  /**
+   * @description ISO 3166-1 two-letter country code max length 2 characters
+   * Required if `location_id` is not provided
+   */
+  country_code?: string;
   /** @description Standardized carrier code the location id belongs to */
   carrier_code?: string;
-  /** @description Location id needed to look up the location */
+  /**
+   * @description Location id needed to look up the location.
+   * Required if `postal_code` or `country_code` is not provided.
+   */
   location_id?: string;
 }

package/src/models/documents/uploads/document-upload-shipment.ts

@@ -0,0 +1,9 @@
+/** @description Shipment information relating to an uploaded document */
+export class DocumentUploadShipment {
+  /** @description The shipment datetime */
+  datetime!: string;
+  /** @description The origin country code */
+  origin_country_code!: string;
+  /** @description The destination country code */
+  destination_country_code!: string;
+}

package/src/models/documents/uploads/index.ts

@@ -1,4 +1,5 @@
 export * from './document-upload-format';
 export * from './document-upload-format-schema';
+export * from './document-upload-shipment';
 export * from './document-upload-type';
 export * from './document-upload-type-schema';

package/src/requests/upload-document-request.ts

@@ -1,5 +1,10 @@
 import { BaseRequest } from './base-request';
-import { Identifier, DocumentUploadFormat, DocumentUploadType } from '../models';
+import {
+  Identifier,
+  DocumentUploadFormat,
+  DocumentUploadShipment,
+  DocumentUploadType,
+} from '../models';
 
 /**
  * A request to upload a document for a shipment.
@@ -19,4 +24,6 @@ export class UploadDocumentRequest extends BaseRequest {
   tracking_number!: string;
   /** @description Non-tracking alternative ids associated with this shipment */
   alternative_identifiers?: Identifier[];
+  /** @description Shipment information relating to an uploaded document */
+  shipment?: DocumentUploadShipment;
 }