@shipengine/connect-carrier-api 4.1.2 → 4.1.4-beta

package/lib/app/metadata/carrier.d.ts

@@ -9,6 +9,7 @@ import { LabelSizesEnum } from './label-sizes';
 import { ConfirmationDictionary } from './confirmation-type';
 import Joi from 'joi';
 import { NativeRatingConfiguration } from './native-rating-configuration';
+import { Zone } from './zone';
 /** @description Basic structure for each carrier */
 export interface Carrier {
     /** @description Defines UI Modals for connecting and updating settings */
@@ -52,5 +53,7 @@ export interface Carrier {
     NativeRating?: NativeRatingConfiguration;
     /** @description This is the file path to the documents template, which is used by Rendering Service. Optional. If it's filled and template file provided, ApiCode must be filled. ApiCode will be used to identify the file in Rendering Service.*/
     DocumentTemplate?: string;
+    /** @description List of possible zones used by the carrier. */
+    Zones?: Zone;
 }
 export declare const CarrierSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/carrier.js

@@ -14,6 +14,7 @@ const confirmation_type_1 = require("./confirmation-type");
 const joi_1 = tslib_1.__importDefault(require("joi"));
 const native_rating_configuration_1 = require("./native-rating-configuration");
 const file_exists_1 = require("./custom-validators/file-exists");
+const zone_1 = require("./zone");
 const connect_runtime_1 = require("@shipengine/connect-runtime");
 exports.CarrierSchema = joi_1.default.object({
     AccountModals: account_modals_1.AccountModalsSchema.required(),
@@ -56,5 +57,6 @@ exports.CarrierSchema = joi_1.default.object({
         .custom(file_exists_1.fileExists, 'template exists')
         .pattern(new RegExp('^.*.carrier$'))
         .message('Template file must have .carrier extension.'),
+    Zones: joi_1.default.array().optional().items(zone_1.ZoneSchema).unique('ApiCode'),
 }).with('DocumentTemplate', 'ApiCode');
 //# sourceMappingURL=carrier.js.map

package/lib/app/metadata/carrier.js.map

@@ -1 +1 @@
-{"version":3,"file":"carrier.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier.ts"],"names":[],"mappings":";;;;AAAA,qDAAsE;AACtE,iDAAgE;AAChE,yDAA4E;AAC5E,uDAA6F;AAC7F,+DAAqF;AACrF,6DAAwF;AACxF,mDAA2E;AAC3E,+CAAqE;AACrE,2DAA2F;AAC3F,sDAAsB;AACtB,+EAGuC;AACvC,iEAA6D;AAE7D,iEAAqF;AA+CxE,QAAA,aAAa,GAAG,aAAG,CAAC,MAAM,CAAC;IACtC,aAAa,EAAE,oCAAmB,CAAC,QAAQ,EAAE;IAC7C,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gCAAiB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1E,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,wCAAqB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAClF,eAAe,EAAE,gDAA8B,CAAC,QAAQ,EAAE;IAC1D,yBAAyB,EAAE,aAAG,CAAC,KAAK,EAAE;SACnC,QAAQ,EAAE;SACV,KAAK,CAAC,8CAAwB,CAAC;SAC/B,MAAM,CAAC,aAAa,CAAC;IACxB,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,kCAAoB,CAAC,CAAC,MAAM,EAAE;IAC9E,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,sCAAsB,CAAC,CAAC,MAAM,EAAE;IAC3E,wBAAwB,EAAE,gDAA4B,CAAC,QAAQ,EAAE;IACjE,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,+CAA0B,CAAC,CAAC,MAAM,EAAE;IACpF,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE;SACtB,QAAQ,EAAE;SACV,OAAO,CACN,IAAI,MAAM,CACR,iGAAiG,CAClG,CACF;SACA,OAAO,CAAC,qBAAqB,CAAC;SAC9B,GAAG,CAAC,GAAG,CAAC;IACX,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAClD,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,8BAAY,EAAE,0CAAwB,CAAC;IAChF,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,aAAG,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;aACf,QAAQ,EAAE;aACV,MAAM,CAAC,wBAAU,EAAE,aAAa,CAAC;aACjC,OAAO,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;aACjC,OAAO,CAAC,iCAAiC,CAAC;QAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;aACf,QAAQ,EAAE;aACV,MAAM,CAAC,wBAAU,EAAE,aAAa,CAAC;aACjC,OAAO,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;aACjC,OAAO,CAAC,iCAAiC,CAAC;KAC9C,CAAC,CAAC,QAAQ,EAAE;IACb,YAAY,EAAE,6DAA+B,CAAC,QAAQ,EAAE;IACxD,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE;SAC3B,QAAQ,EAAE;SACV,MAAM,CAAC,wBAAU,EAAE,iBAAiB,CAAC;SACrC,OAAO,CAAC,IAAI,MAAM,CAAC,cAAc,CAAC,CAAC;SACnC,OAAO,CAAC,6CAA6C,CAAC;CAC1D,CAAC,CAAC,IAAI,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC"}
+{"version":3,"file":"carrier.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier.ts"],"names":[],"mappings":";;;;AAAA,qDAAsE;AACtE,iDAAgE;AAChE,yDAA4E;AAC5E,uDAA6F;AAC7F,+DAAqF;AACrF,6DAAwF;AACxF,mDAA2E;AAC3E,+CAAqE;AACrE,2DAA2F;AAC3F,sDAAsB;AACtB,+EAGuC;AACvC,iEAA6D;AAC7D,iCAA0C;AAE1C,iEAAqF;AAiDxE,QAAA,aAAa,GAAG,aAAG,CAAC,MAAM,CAAC;IACtC,aAAa,EAAE,oCAAmB,CAAC,QAAQ,EAAE;IAC7C,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gCAAiB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1E,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,wCAAqB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAClF,eAAe,EAAE,gDAA8B,CAAC,QAAQ,EAAE;IAC1D,yBAAyB,EAAE,aAAG,CAAC,KAAK,EAAE;SACnC,QAAQ,EAAE;SACV,KAAK,CAAC,8CAAwB,CAAC;SAC/B,MAAM,CAAC,aAAa,CAAC;IACxB,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,kCAAoB,CAAC,CAAC,MAAM,EAAE;IAC9E,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,sCAAsB,CAAC,CAAC,MAAM,EAAE;IAC3E,wBAAwB,EAAE,gDAA4B,CAAC,QAAQ,EAAE;IACjE,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,+CAA0B,CAAC,CAAC,MAAM,EAAE;IACpF,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE;SACtB,QAAQ,EAAE;SACV,OAAO,CACN,IAAI,MAAM,CACR,iGAAiG,CAClG,CACF;SACA,OAAO,CAAC,qBAAqB,CAAC;SAC9B,GAAG,CAAC,GAAG,CAAC;IACX,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAClD,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,8BAAY,EAAE,0CAAwB,CAAC;IAChF,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,aAAG,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;aACf,QAAQ,EAAE;aACV,MAAM,CAAC,wBAAU,EAAE,aAAa,CAAC;aACjC,OAAO,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;aACjC,OAAO,CAAC,iCAAiC,CAAC;QAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;aACf,QAAQ,EAAE;aACV,MAAM,CAAC,wBAAU,EAAE,aAAa,CAAC;aACjC,OAAO,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;aACjC,OAAO,CAAC,iCAAiC,CAAC;KAC9C,CAAC,CAAC,QAAQ,EAAE;IACb,YAAY,EAAE,6DAA+B,CAAC,QAAQ,EAAE;IACxD,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE;SAC3B,QAAQ,EAAE;SACV,MAAM,CAAC,wBAAU,EAAE,iBAAiB,CAAC;SACrC,OAAO,CAAC,IAAI,MAAM,CAAC,cAAc,CAAC,CAAC;SACnC,OAAO,CAAC,6CAA6C,CAAC;IACzD,KAAK,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,iBAAU,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;CAClE,CAAC,CAAC,IAAI,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC"}

package/lib/app/metadata/native-rating-configuration.d.ts

@@ -3,7 +3,7 @@ import { RateCard } from './rate-card';
 /** Configuration for attaching Native Rating to a carrier */
 export interface NativeRatingConfiguration {
     /** @description Default rate card to use for rating */
-    DefaultRateCardId: string;
+    DefaultRateCardId?: string;
     /** Path to rating logic and rate card data for this carrier */
     Path?: string;
     /** Array of rate cards for the carrier */

package/lib/app/metadata/native-rating-configuration.js

@@ -6,7 +6,7 @@ const joi_1 = tslib_1.__importDefault(require("joi"));
 const file_exists_1 = require("./custom-validators/file-exists");
 const rate_card_1 = require("./rate-card");
 exports.NativeRatingConfigurationSchema = joi_1.default.object({
-    DefaultRateCardId: joi_1.default.string().required(),
+    DefaultRateCardId: joi_1.default.string().optional(),
     Path: joi_1.default.string().optional().custom(file_exists_1.fileExists, 'implementation path exists'),
     RateCards: joi_1.default.array().optional().items(rate_card_1.RateCardSchema).unique('Id'),
 });

package/lib/app/metadata/zone.d.ts

@@ -0,0 +1,11 @@
+import Joi from 'joi';
+/** @description Basic details about a carrier zone */
+export interface Zone {
+    /** @description The name of this zone ex: '1' or 'EU-3' */
+    Name: string;
+    /** @description This is a human readable description about what the zone is */
+    Description?: string;
+    /** @description The identifier for this zone that could be used for rating keys. Must be snake cased and unique */
+    ApiCode: string;
+}
+export declare const ZoneSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/zone.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZoneSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const connect_runtime_1 = require("@shipengine/connect-runtime");
+exports.ZoneSchema = joi_1.default.object({
+    Name: joi_1.default.string().required().max(50),
+    Description: joi_1.default.string().optional().max(500),
+    ApiCode: joi_1.default.string().optional().pattern(connect_runtime_1.ApiCodeRegex, connect_runtime_1.ApiCodeValidationMessage),
+});
+//# sourceMappingURL=zone.js.map

package/lib/app/metadata/zone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zone.js","sourceRoot":"","sources":["../../../src/app/metadata/zone.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,iEAAqF;AAYxE,QAAA,UAAU,GAAG,aAAG,CAAC,MAAM,CAAC;IACnC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAC7C,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,8BAAY,EAAE,0CAAwB,CAAC;CACjF,CAAC,CAAC"}

package/lib/models/dangerous-good/dangerous-goods.d.ts

@@ -2,6 +2,7 @@ import { PackageInstructionSectionTypes } from './package-instruction-section-ty
 import { PackagingGroupTypes } from './packaging-group-types';
 import { RegulationLevelTypes } from './regulation-level-types';
 import { TransportMeanTypes } from './transport-mean-types';
+import { DangerousAmountDetails } from './weight-details';
 /** @description Basic structure for a dangerous goods */
 export declare class DangerousGoods {
     /** @description UN number to identify the dangerous goods */
@@ -17,7 +18,7 @@ export declare class DangerousGoods {
     /** @description This indicates the packaging group based on the degree of danger */
     packaging_group?: PackagingGroupTypes;
     /** @description The amount of the dangerous goods */
-    dangerous_amount?: string;
+    dangerous_amount?: DangerousAmountDetails;
     /** @description Quantity of dangerous goods */
     quantity?: number;
     /** @description The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container */

package/lib/models/dangerous-good/dangerous-goods.js.map

@@ -1 +1 @@
-{"version":3,"file":"dangerous-goods.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods.ts"],"names":[],"mappings":";;;AAKA,yDAAyD;AACzD,MAAa,cAAc;IACzB,6DAA6D;IAC7D,SAAS,CAAU;IACnB,4DAA4D;IAC5D,aAAa,CAAU;IACvB,4EAA4E;IAC5E,cAAc,CAAU;IACxB,qEAAqE;IACrE,aAAa,CAAU;IACvB,0GAA0G;IAC1G,wBAAwB,CAAU;IAClC,oFAAoF;IACpF,eAAe,CAAuB;IACtC,qDAAqD;IACrD,gBAAgB,CAAU;IAC1B,+CAA+C;IAC/C,QAAQ,CAAU;IAClB,uJAAuJ;IACvJ,qBAAqB,CAAU;IAC/B,sGAAsG;IACtG,6BAA6B,CAAkC;IAC/D,qFAAqF;IACrF,cAAc,CAAU;IACxB,0FAA0F;IAC1F,cAAc,CAAsB;IACpC,0FAA0F;IAC1F,kBAAkB,CAAU;IAC5B,oDAAoD;IACpD,oBAAoB,CAAU;IAC9B,2DAA2D;IAC3D,gBAAgB,CAAwB;IACxC,8DAA8D;IAC9D,WAAW,CAAW;IACtB,kHAAkH;IAClH,mBAAmB,CAAW;IAC9B,wFAAwF;IACxF,WAAW,CAAU;IACrB,sKAAsK;IACtK,sBAAsB,CAAU;CACjC;AAvCD,wCAuCC"}
+{"version":3,"file":"dangerous-goods.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods.ts"],"names":[],"mappings":";;;AAMA,yDAAyD;AACzD,MAAa,cAAc;IACzB,6DAA6D;IAC7D,SAAS,CAAU;IACnB,4DAA4D;IAC5D,aAAa,CAAU;IACvB,4EAA4E;IAC5E,cAAc,CAAU;IACxB,qEAAqE;IACrE,aAAa,CAAU;IACvB,0GAA0G;IAC1G,wBAAwB,CAAU;IAClC,oFAAoF;IACpF,eAAe,CAAuB;IACtC,qDAAqD;IACrD,gBAAgB,CAA0B;IAC1C,+CAA+C;IAC/C,QAAQ,CAAU;IAClB,uJAAuJ;IACvJ,qBAAqB,CAAU;IAC/B,sGAAsG;IACtG,6BAA6B,CAAkC;IAC/D,qFAAqF;IACrF,cAAc,CAAU;IACxB,0FAA0F;IAC1F,cAAc,CAAsB;IACpC,0FAA0F;IAC1F,kBAAkB,CAAU;IAC5B,oDAAoD;IACpD,oBAAoB,CAAU;IAC9B,2DAA2D;IAC3D,gBAAgB,CAAwB;IACxC,8DAA8D;IAC9D,WAAW,CAAW;IACtB,kHAAkH;IAClH,mBAAmB,CAAW;IAC9B,wFAAwF;IACxF,WAAW,CAAU;IACrB,sKAAsK;IACtK,sBAAsB,CAAU;CACjC;AAvCD,wCAuCC"}

package/lib/models/dangerous-good/transport-mean-types.d.ts

@@ -5,7 +5,7 @@ export declare enum TransportMeanTypes {
     /** @description water transport */
     Water = "water",
     /** @description cargo aircraft only transport */
-    CAO = "cao",
+    Cargo_Aircraft_Only = "cargo_aircraft_only",
     /** @description passenger aircraft transport */
-    PA = "pa"
+    Passenger_Aircraft = "passenger_aircraft"
 }

package/lib/models/dangerous-good/transport-mean-types.js

@@ -9,8 +9,8 @@ var TransportMeanTypes;
     /** @description water transport */
     TransportMeanTypes["Water"] = "water";
     /** @description cargo aircraft only transport */
-    TransportMeanTypes["CAO"] = "cao";
+    TransportMeanTypes["Cargo_Aircraft_Only"] = "cargo_aircraft_only";
     /** @description passenger aircraft transport */
-    TransportMeanTypes["PA"] = "pa";
+    TransportMeanTypes["Passenger_Aircraft"] = "passenger_aircraft";
 })(TransportMeanTypes = exports.TransportMeanTypes || (exports.TransportMeanTypes = {}));
 //# sourceMappingURL=transport-mean-types.js.map

package/lib/models/dangerous-good/transport-mean-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"transport-mean-types.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/transport-mean-types.ts"],"names":[],"mappings":";;;AAAA,8DAA8D;AAC9D,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,oCAAoC;IACpC,uCAAiB,CAAA;IACjB,mCAAmC;IACnC,qCAAe,CAAA;IACf,iDAAiD;IACjD,iCAAW,CAAA;IACX,gDAAgD;IAChD,+BAAS,CAAA;AACX,CAAC,EATW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAS7B"}
+{"version":3,"file":"transport-mean-types.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/transport-mean-types.ts"],"names":[],"mappings":";;;AAAA,8DAA8D;AAC9D,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,oCAAoC;IACpC,uCAAiB,CAAA;IACjB,mCAAmC;IACnC,qCAAe,CAAA;IACf,iDAAiD;IACjD,iEAA2C,CAAA;IAC3C,gDAAgD;IAChD,+DAAyC,CAAA;AAC3C,CAAC,EATW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAS7B"}

package/lib/models/dangerous-good/weight-details.d.ts

@@ -0,0 +1,7 @@
+/** @description This model represents the amount of the dangerous goods */
+export declare class DangerousAmountDetails {
+    /** @description The amount of dangerous goods */
+    amount?: number;
+    /** @description The unit of dangerous goods */
+    unit?: string;
+}

package/lib/models/dangerous-good/weight-details.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DangerousAmountDetails = void 0;
+/** @description This model represents the amount of the dangerous goods */
+class DangerousAmountDetails {
+    /** @description The amount of dangerous goods */
+    amount;
+    /** @description The unit of dangerous goods */
+    unit;
+}
+exports.DangerousAmountDetails = DangerousAmountDetails;
+//# sourceMappingURL=weight-details.js.map

package/lib/models/dangerous-good/weight-details.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"weight-details.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/weight-details.ts"],"names":[],"mappings":";;;AAAA,2EAA2E;AAC3E,MAAa,sBAAsB;IACjC,iDAAiD;IACjD,MAAM,CAAU;IAChB,+CAA+C;IAC/C,IAAI,CAAU;CACf;AALD,wDAKC"}

package/package.json

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

package/spec.json

@@ -1200,8 +1200,8 @@
         "enum": [
           "ground",
           "water",
-          "cao",
-          "pa"
+          "cargo_aircraft_only",
+          "passenger_aircraft"
         ],
         "type": "string",
         "description": "An enumeration for transport means for dangerous goods."
@@ -1875,6 +1875,24 @@
         "type": "string",
         "description": "What to do if the shipment is undeliverable."
       },
+      "DangerousAmountDetails": {
+        "type": "object",
+        "properties": {
+          "amount": {
+            "type": "number",
+            "description": "The amount of dangerous goods.",
+            "format": "double",
+            "nullable": true
+          },
+          "unit": {
+            "type": "string",
+            "description": "The unit of dangerous goods.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "This model represents the amount of the dangerous goods."
+      },
       "DimensionDetails": {
         "type": "object",
         "properties": {
@@ -2845,9 +2863,7 @@
             "$ref": "#/components/schemas/PackagingGroupTypes"
           },
           "dangerous_amount": {
-            "type": "string",
-            "description": "The amount of the dangerous goods.",
-            "nullable": true
+            "$ref": "#/components/schemas/DangerousAmountDetails"
           },
           "quantity": {
             "type": "number",

package/src/app/metadata/carrier.ts

@@ -13,6 +13,7 @@ import {
   NativeRatingConfigurationSchema,
 } from './native-rating-configuration';
 import { fileExists } from './custom-validators/file-exists';
+import { Zone, ZoneSchema } from './zone';
 
 import { ApiCodeRegex, ApiCodeValidationMessage } from '@shipengine/connect-runtime';
 
@@ -59,6 +60,8 @@ export interface Carrier {
   NativeRating?: NativeRatingConfiguration;
   /** @description This is the file path to the documents template, which is used by Rendering Service. Optional. If it's filled and template file provided, ApiCode must be filled. ApiCode will be used to identify the file in Rendering Service.*/
   DocumentTemplate?: string;
+  /** @description List of possible zones used by the carrier. */
+  Zones?: Zone;
 }
 
 export const CarrierSchema = Joi.object({
@@ -106,4 +109,5 @@ export const CarrierSchema = Joi.object({
     .custom(fileExists, 'template exists')
     .pattern(new RegExp('^.*.carrier$'))
     .message('Template file must have .carrier extension.'),
+  Zones: Joi.array().optional().items(ZoneSchema).unique('ApiCode'),
 }).with('DocumentTemplate', 'ApiCode');

package/src/app/metadata/native-rating-configuration.ts

@@ -5,7 +5,7 @@ import { RateCard, RateCardSchema } from './rate-card';
 /** Configuration for attaching Native Rating to a carrier */
 export interface NativeRatingConfiguration {
   /** @description Default rate card to use for rating */
-  DefaultRateCardId: string;
+  DefaultRateCardId?: string;
   /** Path to rating logic and rate card data for this carrier */
   Path?: string;
   /** Array of rate cards for the carrier */
@@ -13,7 +13,7 @@ export interface NativeRatingConfiguration {
 }
 
 export const NativeRatingConfigurationSchema = Joi.object({
-  DefaultRateCardId: Joi.string().required(),
+  DefaultRateCardId: Joi.string().optional(),
   Path: Joi.string().optional().custom(fileExists, 'implementation path exists'),
   RateCards: Joi.array().optional().items(RateCardSchema).unique('Id'),
 });

package/src/app/metadata/zone.ts

@@ -0,0 +1,18 @@
+import Joi from 'joi';
+import { ApiCodeRegex, ApiCodeValidationMessage } from '@shipengine/connect-runtime';
+
+/** @description Basic details about a carrier zone */
+export interface Zone {
+  /** @description The name of this zone ex: '1' or 'EU-3' */
+  Name: string;
+  /** @description This is a human readable description about what the zone is */
+  Description?: string;
+  /** @description The identifier for this zone that could be used for rating keys. Must be snake cased and unique */
+  ApiCode: string;
+}
+
+export const ZoneSchema = Joi.object({
+  Name: Joi.string().required().max(50),
+  Description: Joi.string().optional().max(500),
+  ApiCode: Joi.string().optional().pattern(ApiCodeRegex, ApiCodeValidationMessage),
+});

package/src/models/dangerous-good/dangerous-goods.ts

@@ -2,6 +2,7 @@ import { PackageInstructionSectionTypes } from './package-instruction-section-ty
 import { PackagingGroupTypes } from './packaging-group-types';
 import { RegulationLevelTypes } from './regulation-level-types';
 import { TransportMeanTypes } from './transport-mean-types';
+import { DangerousAmountDetails } from './weight-details';
 
 /** @description Basic structure for a dangerous goods */
 export class DangerousGoods {
@@ -18,7 +19,7 @@ export class DangerousGoods {
   /** @description This indicates the packaging group based on the degree of danger */
   packaging_group?: PackagingGroupTypes;
   /** @description The amount of the dangerous goods */
-  dangerous_amount?: string;
+  dangerous_amount?: DangerousAmountDetails;
   /** @description Quantity of dangerous goods */
   quantity?: number;
   /** @description The specific standardized packaging instructions from the relevant regulatory agency that have been applied to the parcel/container */

package/src/models/dangerous-good/transport-mean-types.ts

@@ -5,7 +5,7 @@ export enum TransportMeanTypes {
   /** @description water transport */
   Water = 'water',
   /** @description cargo aircraft only transport */
-  CAO = 'cao',
+  Cargo_Aircraft_Only = 'cargo_aircraft_only',
   /** @description passenger aircraft transport */
-  PA = 'pa',
+  Passenger_Aircraft = 'passenger_aircraft',
 }

package/src/models/dangerous-good/weight-details.ts

@@ -0,0 +1,7 @@
+/** @description This model represents the amount of the dangerous goods */
+export class DangerousAmountDetails {
+  /** @description The amount of dangerous goods */
+  amount?: number;
+  /** @description The unit of dangerous goods */
+  unit?: string;
+}