@shipengine/connect-carrier-api 4.22.0 → 4.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/app/metadata/shipping-option.d.ts +1 -0
- package/lib/app/metadata/shipping-option.js +1 -0
- package/lib/app/metadata/shipping-option.js.map +1 -1
- package/lib/models/advanced-options.d.ts +2 -0
- package/lib/models/advanced-options.js +2 -0
- package/lib/models/advanced-options.js.map +1 -1
- package/lib/models/dangerous-good/dangerous-goods-declaration.d.ts +6 -1
- package/lib/models/dangerous-good/dangerous-goods-declaration.js +4 -0
- package/lib/models/dangerous-good/dangerous-goods-declaration.js.map +1 -1
- package/lib/models/dangerous-good/dangerous-goods-package-info.d.ts +5 -2
- package/lib/models/dangerous-good/dangerous-goods-package-info.js +2 -0
- package/lib/models/dangerous-good/dangerous-goods-package-info.js.map +1 -1
- package/lib/models/dangerous-good/regulation-level-types.d.ts +11 -0
- package/lib/models/dangerous-good/regulation-level-types.js +13 -1
- package/lib/models/dangerous-good/regulation-level-types.js.map +1 -1
- package/lib/models/dangerous-good/regulation-set-types.d.ts +15 -0
- package/lib/models/dangerous-good/regulation-set-types.js +20 -0
- package/lib/models/dangerous-good/regulation-set-types.js.map +1 -0
- package/package.json +1 -1
- package/spec.json +7 -2
- package/src/app/metadata/shipping-option.ts +1 -0
- package/src/models/advanced-options.ts +2 -0
- package/src/models/dangerous-good/dangerous-goods-declaration.ts +6 -1
- package/src/models/dangerous-good/dangerous-goods-package-info.ts +5 -2
- package/src/models/dangerous-good/regulation-level-types.ts +12 -0
- package/src/models/dangerous-good/regulation-set-types.ts +15 -0
- package/tsconfig.tsbuildinfo +1 -1
|
@@ -48,6 +48,7 @@ export declare enum ShippingOptionEnum {
|
|
|
48
48
|
Disassembly = "disassembly",
|
|
49
49
|
CustomerExpectedDeliveryFromDate = "customer-expected-delivery-from-date",
|
|
50
50
|
CustomerExpectedDeliveryToDate = "customer-expected-delivery-to-date",
|
|
51
|
+
Fragile = "fragile",
|
|
51
52
|
DeliveryAsAddressed = "delivery-as-addressed",
|
|
52
53
|
ReturnAfterFirstAttempt = "return-after-first-attempt"
|
|
53
54
|
}
|
|
@@ -44,6 +44,7 @@ var ShippingOptionEnum;
|
|
|
44
44
|
ShippingOptionEnum["Disassembly"] = "disassembly";
|
|
45
45
|
ShippingOptionEnum["CustomerExpectedDeliveryFromDate"] = "customer-expected-delivery-from-date";
|
|
46
46
|
ShippingOptionEnum["CustomerExpectedDeliveryToDate"] = "customer-expected-delivery-to-date";
|
|
47
|
+
ShippingOptionEnum["Fragile"] = "fragile";
|
|
47
48
|
ShippingOptionEnum["DeliveryAsAddressed"] = "delivery-as-addressed";
|
|
48
49
|
ShippingOptionEnum["ReturnAfterFirstAttempt"] = "return-after-first-attempt";
|
|
49
50
|
})(ShippingOptionEnum || (exports.ShippingOptionEnum = ShippingOptionEnum = {}));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shipping-option.js","sourceRoot":"","sources":["../../../src/app/metadata/shipping-option.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAYT,QAAA,+BAA+B,GAAG,aAAG,CAAC,MAAM,CAAC;IACxD,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;CAC9C,CAAC,CAAC,QAAQ,EAAE,CAAC;AAEd,IAAY,
|
|
1
|
+
{"version":3,"file":"shipping-option.js","sourceRoot":"","sources":["../../../src/app/metadata/shipping-option.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAYT,QAAA,+BAA+B,GAAG,aAAG,CAAC,MAAM,CAAC;IACxD,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;CAC9C,CAAC,CAAC,QAAQ,EAAE,CAAC;AAEd,IAAY,kBAuCX;AAvCD,WAAY,kBAAkB;IAC5B,iDAA2B,CAAA;IAC3B,gDAA0B,CAAA;IAC1B,qDAA+B,CAAA;IAC/B,8DAAwC,CAAA;IACxC,+DAAyC,CAAA;IACzC,8DAAwC,CAAA;IACxC,wDAAkC,CAAA;IAClC,0DAAoC,CAAA;IACpC,+DAAyC,CAAA;IACzC,wCAAkB,CAAA;IAClB,8DAAwC,CAAA;IACxC,oDAA8B,CAAA;IAC9B,uDAAiC,CAAA;IACjC,iEAA2C,CAAA;IAC3C,oDAA8B,CAAA;IAC9B,sDAAgC,CAAA;IAChC,4DAAsC,CAAA;IACtC,4DAAsC,CAAA;IACtC,wEAAkD,CAAA;IAClD,6CAAuB,CAAA;IACvB,4DAAsC,CAAA;IACtC,8DAAwC,CAAA;IACxC,0DAAoC,CAAA;IACpC,0DAAoC,CAAA;IACpC,mEAA6C,CAAA;IAC7C,4DAAsC,CAAA;IACtC,gGAA0E,CAAA;IAC1E,iFAA2D,CAAA;IAC3D,qEAA+C,CAAA;IAC/C,uCAAiB,CAAA;IACjB,8DAAwC,CAAA;IACxC,2CAAqB,CAAA;IACrB,iDAA2B,CAAA;IAC3B,+FAAyE,CAAA;IACzE,2FAAqE,CAAA;IACrE,yCAAmB,CAAA;IACnB,mEAA6C,CAAA;IAC7C,4EAAsD,CAAA;AACxD,CAAC,EAvCW,kBAAkB,kCAAlB,kBAAkB,QAuC7B;AAEY,QAAA,8BAA8B,GAAG,aAAG,CAAC,MAAM,CACtD,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC,WAAgB,EAAE,MAAM,EAAE,EAAE;IACpE,WAAW,CAAC,MAAM,CAAC,GAAG,uCAA+B,CAAC;IACtD,OAAO,WAAW,CAAC;AACrB,CAAC,EAAE,EAAE,CAAC,CACP,CAAC"}
|
|
@@ -57,6 +57,8 @@ export declare class AdvancedOptions {
|
|
|
57
57
|
disassembly?: boolean;
|
|
58
58
|
/** @description The date range when the customer expects the shipment to be delivered. ISO 8601 format */
|
|
59
59
|
customer_expected_delivery?: CustomerExpectedDelivery;
|
|
60
|
+
/** @description Describes whether or not the shipment is fragile. */
|
|
61
|
+
fragile?: boolean;
|
|
60
62
|
/** @description Indicates whether the recipient should be notified of events related to the shipment. */
|
|
61
63
|
delivery_as_addressed?: boolean;
|
|
62
64
|
/** @description Instructs the carrier to deliver the package only to the exact address provided. */
|
|
@@ -51,6 +51,8 @@ class AdvancedOptions {
|
|
|
51
51
|
disassembly;
|
|
52
52
|
/** @description The date range when the customer expects the shipment to be delivered. ISO 8601 format */
|
|
53
53
|
customer_expected_delivery;
|
|
54
|
+
/** @description Describes whether or not the shipment is fragile. */
|
|
55
|
+
fragile;
|
|
54
56
|
/** @description Indicates whether the recipient should be notified of events related to the shipment. */
|
|
55
57
|
delivery_as_addressed;
|
|
56
58
|
/** @description Instructs the carrier to deliver the package only to the exact address provided. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"advanced-options.js","sourceRoot":"","sources":["../../src/models/advanced-options.ts"],"names":[],"mappings":";;;AAUA,wDAAwD;AACxD,MAAa,eAAe;IAC1B,0DAA0D;IAC1D,sBAAsB,CAAW;IACjC,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,yGAAyG;IACzG,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;IACpC,yFAAyF;IACzF,MAAM,CAAW;IACjB,uHAAuH;IACvH,kBAAkB,CAAW;IAC7B,qFAAqF;IACrF,QAAQ,CAAW;IACnB,kHAAkH;IAClH,WAAW,CAAW;IACtB,0GAA0G;IAC1G,0BAA0B,CAA4B;IACtD,yGAAyG;IACzG,qBAAqB,CAAW;IAChC,oGAAoG;IACpG,0BAA0B,CAAW;CAGtC;
|
|
1
|
+
{"version":3,"file":"advanced-options.js","sourceRoot":"","sources":["../../src/models/advanced-options.ts"],"names":[],"mappings":";;;AAUA,wDAAwD;AACxD,MAAa,eAAe;IAC1B,0DAA0D;IAC1D,sBAAsB,CAAW;IACjC,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,yGAAyG;IACzG,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;IACpC,yFAAyF;IACzF,MAAM,CAAW;IACjB,uHAAuH;IACvH,kBAAkB,CAAW;IAC7B,qFAAqF;IACrF,QAAQ,CAAW;IACnB,kHAAkH;IAClH,WAAW,CAAW;IACtB,0GAA0G;IAC1G,0BAA0B,CAA4B;IACtD,qEAAqE;IACrE,OAAO,CAAW;IAClB,yGAAyG;IACzG,qBAAqB,CAAW;IAChC,oGAAoG;IACpG,0BAA0B,CAAW;CAGtC;AAzDD,0CAyDC"}
|
|
@@ -1,13 +1,18 @@
|
|
|
1
1
|
import { Signatory } from '../signatory';
|
|
2
2
|
import { DangerousGoodsContact } from './dangerous-goods-contact';
|
|
3
|
+
import { RegulationSetTypes } from './regulation-set-types';
|
|
3
4
|
/** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
|
|
4
5
|
export declare class DangerousGoodsDeclaration {
|
|
6
|
+
/** @description Indicates whether a shipper declaration is required for the dangerous goods shipment */
|
|
7
|
+
shipper_declaration?: boolean;
|
|
5
8
|
/** @description Name of the regulatory authority */
|
|
6
|
-
regulation_set?:
|
|
9
|
+
regulation_set?: RegulationSetTypes;
|
|
7
10
|
/** @description Contact information for Dangerous goods */
|
|
8
11
|
emergency_contact?: DangerousGoodsContact;
|
|
9
12
|
/** @description An object containing details of the person signing the dangerous goods declaration. */
|
|
10
13
|
signatory?: Signatory;
|
|
11
14
|
/** @description Any supplementary instructions or special provisions related to the handling of the dangerous goods shipment, such as competent authority approvals or specific handling requirements. */
|
|
12
15
|
additional_handling_information?: string;
|
|
16
|
+
/** @description Indicates whether the shipment contains alcohol */
|
|
17
|
+
contains_alcohol?: boolean;
|
|
13
18
|
}
|
|
@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.DangerousGoodsDeclaration = void 0;
|
|
4
4
|
/** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
|
|
5
5
|
class DangerousGoodsDeclaration {
|
|
6
|
+
/** @description Indicates whether a shipper declaration is required for the dangerous goods shipment */
|
|
7
|
+
shipper_declaration;
|
|
6
8
|
/** @description Name of the regulatory authority */
|
|
7
9
|
regulation_set;
|
|
8
10
|
/** @description Contact information for Dangerous goods */
|
|
@@ -11,6 +13,8 @@ class DangerousGoodsDeclaration {
|
|
|
11
13
|
signatory;
|
|
12
14
|
/** @description Any supplementary instructions or special provisions related to the handling of the dangerous goods shipment, such as competent authority approvals or specific handling requirements. */
|
|
13
15
|
additional_handling_information;
|
|
16
|
+
/** @description Indicates whether the shipment contains alcohol */
|
|
17
|
+
contains_alcohol;
|
|
14
18
|
}
|
|
15
19
|
exports.DangerousGoodsDeclaration = DangerousGoodsDeclaration;
|
|
16
20
|
//# sourceMappingURL=dangerous-goods-declaration.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dangerous-goods-declaration.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods-declaration.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"dangerous-goods-declaration.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods-declaration.ts"],"names":[],"mappings":";;;AAIA,8HAA8H;AAC9H,MAAa,yBAAyB;IACpC,wGAAwG;IACxG,mBAAmB,CAAW;IAC9B,oDAAoD;IACpD,cAAc,CAAsB;IACpC,2DAA2D;IAC3D,iBAAiB,CAAyB;IAC1C,uGAAuG;IACvG,SAAS,CAAa;IACtB,0MAA0M;IAC1M,+BAA+B,CAAU;IACzC,mEAAmE;IACnE,gBAAgB,CAAW;CAC5B;AAbD,8DAaC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { RegulationLevelTypesV2 } from './regulation-level-types';
|
|
2
2
|
import { TransportMeanTypes } from './transport-mean-types';
|
|
3
|
+
import { CarrierWeight } from '../units/carrier-weight';
|
|
3
4
|
/** @description An object containing information specific to the dangerous goods aspects of an individual package. */
|
|
4
5
|
export declare class DangerousGoodsPackageInfo {
|
|
5
6
|
/** @description Transportation means through which the dangerous goods are transported */
|
|
@@ -15,5 +16,7 @@ export declare class DangerousGoodsPackageInfo {
|
|
|
15
16
|
/** @description The type of outer packaging used for the dangerous goods package, typically represented by a UN packaging code (e.g., "4G" for fiberboard box, "1A2" for steel drum). */
|
|
16
17
|
outer_packaging_type?: string;
|
|
17
18
|
/** @description Regulation level of the dangerous goods */
|
|
18
|
-
regulation_level?:
|
|
19
|
+
regulation_level?: RegulationLevelTypesV2;
|
|
20
|
+
/** @description The weight of dry ice in the package */
|
|
21
|
+
dry_ice?: CarrierWeight;
|
|
19
22
|
}
|
|
@@ -17,6 +17,8 @@ class DangerousGoodsPackageInfo {
|
|
|
17
17
|
outer_packaging_type;
|
|
18
18
|
/** @description Regulation level of the dangerous goods */
|
|
19
19
|
regulation_level;
|
|
20
|
+
/** @description The weight of dry ice in the package */
|
|
21
|
+
dry_ice;
|
|
20
22
|
}
|
|
21
23
|
exports.DangerousGoodsPackageInfo = DangerousGoodsPackageInfo;
|
|
22
24
|
//# sourceMappingURL=dangerous-goods-package-info.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dangerous-goods-package-info.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods-package-info.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"dangerous-goods-package-info.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods-package-info.ts"],"names":[],"mappings":";;;AAIA,sHAAsH;AACtH,MAAa,yBAAyB;IACpC,0FAA0F;IAC1F,cAAc,CAAsB;IACpC,qKAAqK;IACrK,aAAa,CAAW;IACxB,0MAA0M;IAC1M,WAAW,CAAW;IACtB,wKAAwK;IACxK,iBAAiB,CAAW;IAC5B,sOAAsO;IACtO,OAAO,CAAU;IACjB,yLAAyL;IACzL,oBAAoB,CAAU;IAC9B,2DAA2D;IAC3D,gBAAgB,CAA0B;IAC1C,wDAAwD;IACxD,OAAO,CAAiB;CACzB;AAjBD,8DAiBC"}
|
|
@@ -9,3 +9,14 @@ export declare enum RegulationLevelTypes {
|
|
|
9
9
|
/** @description excepted quantity regulated */
|
|
10
10
|
ExceptedQuantity = "excepted_quantity"
|
|
11
11
|
}
|
|
12
|
+
/** @description Types of regulation level defined for dangerous good (V2) */
|
|
13
|
+
export declare enum RegulationLevelTypesV2 {
|
|
14
|
+
/** @description lightly regulated */
|
|
15
|
+
LightlyRegulated = "lightly_regulated",
|
|
16
|
+
/** @description fully regualted */
|
|
17
|
+
FullyRegulated = "fully_regulated",
|
|
18
|
+
/** @description limited quantity regulated */
|
|
19
|
+
LimitedQuantity = "limited_quantity",
|
|
20
|
+
/** @description excepted quantity regulated */
|
|
21
|
+
ExceptedQuantity = "excepted_quantity"
|
|
22
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.RegulationLevelTypes = void 0;
|
|
3
|
+
exports.RegulationLevelTypesV2 = exports.RegulationLevelTypes = void 0;
|
|
4
4
|
/** @description Types of regulation level defined for dangerous good */
|
|
5
5
|
var RegulationLevelTypes;
|
|
6
6
|
(function (RegulationLevelTypes) {
|
|
@@ -13,4 +13,16 @@ var RegulationLevelTypes;
|
|
|
13
13
|
/** @description excepted quantity regulated */
|
|
14
14
|
RegulationLevelTypes["ExceptedQuantity"] = "excepted_quantity";
|
|
15
15
|
})(RegulationLevelTypes || (exports.RegulationLevelTypes = RegulationLevelTypes = {}));
|
|
16
|
+
/** @description Types of regulation level defined for dangerous good (V2) */
|
|
17
|
+
var RegulationLevelTypesV2;
|
|
18
|
+
(function (RegulationLevelTypesV2) {
|
|
19
|
+
/** @description lightly regulated */
|
|
20
|
+
RegulationLevelTypesV2["LightlyRegulated"] = "lightly_regulated";
|
|
21
|
+
/** @description fully regualted */
|
|
22
|
+
RegulationLevelTypesV2["FullyRegulated"] = "fully_regulated";
|
|
23
|
+
/** @description limited quantity regulated */
|
|
24
|
+
RegulationLevelTypesV2["LimitedQuantity"] = "limited_quantity";
|
|
25
|
+
/** @description excepted quantity regulated */
|
|
26
|
+
RegulationLevelTypesV2["ExceptedQuantity"] = "excepted_quantity";
|
|
27
|
+
})(RegulationLevelTypesV2 || (exports.RegulationLevelTypesV2 = RegulationLevelTypesV2 = {}));
|
|
16
28
|
//# sourceMappingURL=regulation-level-types.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"regulation-level-types.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/regulation-level-types.ts"],"names":[],"mappings":";;;AAAA,wEAAwE;AACxE,IAAY,oBASX;AATD,WAAY,oBAAoB;IAC9B,qCAAqC;IACrC,8DAAsC,CAAA;IACtC,mCAAmC;IACnC,0DAAkC,CAAA;IAClC,gDAAgD;IAChD,gEAAwC,CAAA;IACxC,+CAA+C;IAC/C,8DAAsC,CAAA;AACxC,CAAC,EATW,oBAAoB,oCAApB,oBAAoB,QAS/B"}
|
|
1
|
+
{"version":3,"file":"regulation-level-types.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/regulation-level-types.ts"],"names":[],"mappings":";;;AAAA,wEAAwE;AACxE,IAAY,oBASX;AATD,WAAY,oBAAoB;IAC9B,qCAAqC;IACrC,8DAAsC,CAAA;IACtC,mCAAmC;IACnC,0DAAkC,CAAA;IAClC,gDAAgD;IAChD,gEAAwC,CAAA;IACxC,+CAA+C;IAC/C,8DAAsC,CAAA;AACxC,CAAC,EATW,oBAAoB,oCAApB,oBAAoB,QAS/B;AAED,6EAA6E;AAC7E,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,qCAAqC;IACrC,gEAAsC,CAAA;IACtC,mCAAmC;IACnC,4DAAkC,CAAA;IAClC,8CAA8C;IAC9C,8DAAoC,CAAA;IACpC,+CAA+C;IAC/C,gEAAsC,CAAA;AACxC,CAAC,EATW,sBAAsB,sCAAtB,sBAAsB,QASjC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/** @description Name of the regulatory authority for dangerous goods */
|
|
2
|
+
export declare enum RegulationSetTypes {
|
|
3
|
+
/** @description International Air Transport Association */
|
|
4
|
+
IATA = "iata",
|
|
5
|
+
/** @description European Agreement concerning the International Carriage of Dangerous Goods by Road */
|
|
6
|
+
ADR = "adr",
|
|
7
|
+
/** @description International Maritime Dangerous Goods */
|
|
8
|
+
IMDG = "imdg",
|
|
9
|
+
/** @description Code of Federal Regulations Title 49 */
|
|
10
|
+
CFR49 = "cfr49",
|
|
11
|
+
/** @description Regulations concerning the International Carriage of Dangerous Goods by Rail */
|
|
12
|
+
RID = "rid",
|
|
13
|
+
/** @description Transportation of Dangerous Goods (Canada) */
|
|
14
|
+
TDG = "tdg"
|
|
15
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RegulationSetTypes = void 0;
|
|
4
|
+
/** @description Name of the regulatory authority for dangerous goods */
|
|
5
|
+
var RegulationSetTypes;
|
|
6
|
+
(function (RegulationSetTypes) {
|
|
7
|
+
/** @description International Air Transport Association */
|
|
8
|
+
RegulationSetTypes["IATA"] = "iata";
|
|
9
|
+
/** @description European Agreement concerning the International Carriage of Dangerous Goods by Road */
|
|
10
|
+
RegulationSetTypes["ADR"] = "adr";
|
|
11
|
+
/** @description International Maritime Dangerous Goods */
|
|
12
|
+
RegulationSetTypes["IMDG"] = "imdg";
|
|
13
|
+
/** @description Code of Federal Regulations Title 49 */
|
|
14
|
+
RegulationSetTypes["CFR49"] = "cfr49";
|
|
15
|
+
/** @description Regulations concerning the International Carriage of Dangerous Goods by Rail */
|
|
16
|
+
RegulationSetTypes["RID"] = "rid";
|
|
17
|
+
/** @description Transportation of Dangerous Goods (Canada) */
|
|
18
|
+
RegulationSetTypes["TDG"] = "tdg";
|
|
19
|
+
})(RegulationSetTypes || (exports.RegulationSetTypes = RegulationSetTypes = {}));
|
|
20
|
+
//# sourceMappingURL=regulation-set-types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"regulation-set-types.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/regulation-set-types.ts"],"names":[],"mappings":";;;AAAA,wEAAwE;AACxE,IAAY,kBAaX;AAbD,WAAY,kBAAkB;IAC5B,2DAA2D;IAC3D,mCAAa,CAAA;IACb,uGAAuG;IACvG,iCAAW,CAAA;IACX,0DAA0D;IAC1D,mCAAa,CAAA;IACb,wDAAwD;IACxD,qCAAe,CAAA;IACf,gGAAgG;IAChG,iCAAW,CAAA;IACX,8DAA8D;IAC9D,iCAAW,CAAA;AACb,CAAC,EAbW,kBAAkB,kCAAlB,kBAAkB,QAa7B"}
|
package/package.json
CHANGED
package/spec.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Shipping API",
|
|
5
5
|
"description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
|
|
6
|
-
"version": "1.
|
|
6
|
+
"version": "1.37.0"
|
|
7
7
|
},
|
|
8
8
|
"paths": {
|
|
9
9
|
"/Register": {
|
|
@@ -951,8 +951,13 @@
|
|
|
951
951
|
"customer_expected_delivery": {
|
|
952
952
|
"$ref": "#/components/schemas/CustomerExpectedDelivery"
|
|
953
953
|
},
|
|
954
|
+
"fragile": {
|
|
955
|
+
"type": "boolean",
|
|
956
|
+
"description": "Indicates whether the shipment contains fragile items that require special handling to prevent damage during transit and delivery."
|
|
957
|
+
},
|
|
954
958
|
"delivery_as_addressed": {
|
|
955
|
-
"type": "boolean"
|
|
959
|
+
"type": "boolean",
|
|
960
|
+
"description": "Instructs the carrier to deliver the package only to the exact address provided."
|
|
956
961
|
},
|
|
957
962
|
"return_after_first_attempt": {
|
|
958
963
|
"type": "boolean",
|
|
@@ -51,6 +51,7 @@ export enum ShippingOptionEnum {
|
|
|
51
51
|
Disassembly = 'disassembly',
|
|
52
52
|
CustomerExpectedDeliveryFromDate = 'customer-expected-delivery-from-date',
|
|
53
53
|
CustomerExpectedDeliveryToDate = 'customer-expected-delivery-to-date',
|
|
54
|
+
Fragile = 'fragile',
|
|
54
55
|
DeliveryAsAddressed = 'delivery-as-addressed',
|
|
55
56
|
ReturnAfterFirstAttempt = 'return-after-first-attempt',
|
|
56
57
|
}
|
|
@@ -58,6 +58,8 @@ export class AdvancedOptions {
|
|
|
58
58
|
disassembly?: boolean;
|
|
59
59
|
/** @description The date range when the customer expects the shipment to be delivered. ISO 8601 format */
|
|
60
60
|
customer_expected_delivery?: CustomerExpectedDelivery;
|
|
61
|
+
/** @description Describes whether or not the shipment is fragile. */
|
|
62
|
+
fragile?: boolean;
|
|
61
63
|
/** @description Indicates whether the recipient should be notified of events related to the shipment. */
|
|
62
64
|
delivery_as_addressed?: boolean;
|
|
63
65
|
/** @description Instructs the carrier to deliver the package only to the exact address provided. */
|
|
@@ -1,14 +1,19 @@
|
|
|
1
1
|
import { Signatory } from '../signatory';
|
|
2
2
|
import { DangerousGoodsContact } from './dangerous-goods-contact';
|
|
3
|
+
import { RegulationSetTypes } from './regulation-set-types';
|
|
3
4
|
|
|
4
5
|
/** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
|
|
5
6
|
export class DangerousGoodsDeclaration {
|
|
7
|
+
/** @description Indicates whether a shipper declaration is required for the dangerous goods shipment */
|
|
8
|
+
shipper_declaration?: boolean;
|
|
6
9
|
/** @description Name of the regulatory authority */
|
|
7
|
-
regulation_set?:
|
|
10
|
+
regulation_set?: RegulationSetTypes;
|
|
8
11
|
/** @description Contact information for Dangerous goods */
|
|
9
12
|
emergency_contact?: DangerousGoodsContact;
|
|
10
13
|
/** @description An object containing details of the person signing the dangerous goods declaration. */
|
|
11
14
|
signatory?: Signatory;
|
|
12
15
|
/** @description Any supplementary instructions or special provisions related to the handling of the dangerous goods shipment, such as competent authority approvals or specific handling requirements. */
|
|
13
16
|
additional_handling_information?: string;
|
|
17
|
+
/** @description Indicates whether the shipment contains alcohol */
|
|
18
|
+
contains_alcohol?: boolean;
|
|
14
19
|
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { RegulationLevelTypesV2 } from './regulation-level-types';
|
|
2
2
|
import { TransportMeanTypes } from './transport-mean-types';
|
|
3
|
+
import { CarrierWeight } from '../units/carrier-weight';
|
|
3
4
|
|
|
4
5
|
/** @description An object containing information specific to the dangerous goods aspects of an individual package. */
|
|
5
6
|
export class DangerousGoodsPackageInfo {
|
|
@@ -16,5 +17,7 @@ export class DangerousGoodsPackageInfo {
|
|
|
16
17
|
/** @description The type of outer packaging used for the dangerous goods package, typically represented by a UN packaging code (e.g., "4G" for fiberboard box, "1A2" for steel drum). */
|
|
17
18
|
outer_packaging_type?: string;
|
|
18
19
|
/** @description Regulation level of the dangerous goods */
|
|
19
|
-
regulation_level?:
|
|
20
|
+
regulation_level?: RegulationLevelTypesV2;
|
|
21
|
+
/** @description The weight of dry ice in the package */
|
|
22
|
+
dry_ice?: CarrierWeight;
|
|
20
23
|
}
|
|
@@ -9,3 +9,15 @@ export enum RegulationLevelTypes {
|
|
|
9
9
|
/** @description excepted quantity regulated */
|
|
10
10
|
ExceptedQuantity = 'excepted_quantity',
|
|
11
11
|
}
|
|
12
|
+
|
|
13
|
+
/** @description Types of regulation level defined for dangerous good (V2) */
|
|
14
|
+
export enum RegulationLevelTypesV2 {
|
|
15
|
+
/** @description lightly regulated */
|
|
16
|
+
LightlyRegulated = 'lightly_regulated',
|
|
17
|
+
/** @description fully regualted */
|
|
18
|
+
FullyRegulated = 'fully_regulated',
|
|
19
|
+
/** @description limited quantity regulated */
|
|
20
|
+
LimitedQuantity = 'limited_quantity',
|
|
21
|
+
/** @description excepted quantity regulated */
|
|
22
|
+
ExceptedQuantity = 'excepted_quantity',
|
|
23
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/** @description Name of the regulatory authority for dangerous goods */
|
|
2
|
+
export enum RegulationSetTypes {
|
|
3
|
+
/** @description International Air Transport Association */
|
|
4
|
+
IATA = 'iata',
|
|
5
|
+
/** @description European Agreement concerning the International Carriage of Dangerous Goods by Road */
|
|
6
|
+
ADR = 'adr',
|
|
7
|
+
/** @description International Maritime Dangerous Goods */
|
|
8
|
+
IMDG = 'imdg',
|
|
9
|
+
/** @description Code of Federal Regulations Title 49 */
|
|
10
|
+
CFR49 = 'cfr49',
|
|
11
|
+
/** @description Regulations concerning the International Carriage of Dangerous Goods by Rail */
|
|
12
|
+
RID = 'rid',
|
|
13
|
+
/** @description Transportation of Dangerous Goods (Canada) */
|
|
14
|
+
TDG = 'tdg',
|
|
15
|
+
}
|