@shipengine/connect-carrier-api 4.16.5 → 4.16.6
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/models/dangerous-good/dangerous-goods-declaration.d.ts +13 -0
- package/lib/models/dangerous-good/dangerous-goods-declaration.js +16 -0
- package/lib/models/dangerous-good/dangerous-goods-declaration.js.map +1 -0
- package/lib/models/dangerous-good/dangerous-goods-inner-packaging.d.ts +7 -0
- package/lib/models/dangerous-good/dangerous-goods-inner-packaging.js +12 -0
- package/lib/models/dangerous-good/dangerous-goods-inner-packaging.js.map +1 -0
- package/lib/models/dangerous-good/dangerous-goods-package-info.d.ts +19 -0
- package/lib/models/dangerous-good/dangerous-goods-package-info.js +22 -0
- package/lib/models/dangerous-good/dangerous-goods-package-info.js.map +1 -0
- package/lib/models/dangerous-good/dangerous-goods.d.ts +5 -0
- package/lib/models/dangerous-good/dangerous-goods.js +4 -0
- package/lib/models/dangerous-good/dangerous-goods.js.map +1 -1
- package/lib/models/package.d.ts +3 -0
- package/lib/models/package.js +2 -0
- package/lib/models/package.js.map +1 -1
- package/lib/requests/create-label-request.d.ts +3 -0
- package/lib/requests/create-label-request.js +2 -0
- package/lib/requests/create-label-request.js.map +1 -1
- package/lib/requests/get-rates-request.d.ts +3 -0
- package/lib/requests/get-rates-request.js +2 -0
- package/lib/requests/get-rates-request.js.map +1 -1
- package/package.json +1 -1
- package/spec.json +101 -2
- package/src/models/dangerous-good/dangerous-goods-declaration.ts +14 -0
- package/src/models/dangerous-good/dangerous-goods-inner-packaging.ts +7 -0
- package/src/models/dangerous-good/dangerous-goods-package-info.ts +20 -0
- package/src/models/dangerous-good/dangerous-goods.ts +5 -0
- package/src/models/package.ts +3 -0
- package/src/requests/create-label-request.ts +3 -0
- package/src/requests/get-rates-request.ts +3 -0
- package/tsconfig.tsbuildinfo +1 -1
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { Signatory } from '../signatory';
|
|
2
|
+
import { DangerousGoodsContact } from './dangerous-goods-contact';
|
|
3
|
+
/** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
|
|
4
|
+
export declare class DangerousGoodsDeclaration {
|
|
5
|
+
/** @description Name of the regulatory authority */
|
|
6
|
+
regulation_set?: string;
|
|
7
|
+
/** @description Contact information for Dangerous goods */
|
|
8
|
+
emergency_contact?: DangerousGoodsContact;
|
|
9
|
+
/** @description An object containing details of the person signing the dangerous goods declaration. */
|
|
10
|
+
signatory?: Signatory;
|
|
11
|
+
/** @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
|
+
additional_handling_information?: string;
|
|
13
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DangerousGoodsDeclaration = void 0;
|
|
4
|
+
/** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
|
|
5
|
+
class DangerousGoodsDeclaration {
|
|
6
|
+
/** @description Name of the regulatory authority */
|
|
7
|
+
regulation_set;
|
|
8
|
+
/** @description Contact information for Dangerous goods */
|
|
9
|
+
emergency_contact;
|
|
10
|
+
/** @description An object containing details of the person signing the dangerous goods declaration. */
|
|
11
|
+
signatory;
|
|
12
|
+
/** @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
|
+
additional_handling_information;
|
|
14
|
+
}
|
|
15
|
+
exports.DangerousGoodsDeclaration = DangerousGoodsDeclaration;
|
|
16
|
+
//# sourceMappingURL=dangerous-goods-declaration.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dangerous-goods-declaration.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods-declaration.ts"],"names":[],"mappings":";;;AAGA,8HAA8H;AAC9H,MAAa,yBAAyB;IACpC,oDAAoD;IACpD,cAAc,CAAU;IACxB,2DAA2D;IAC3D,iBAAiB,CAAyB;IAC1C,uGAAuG;IACvG,SAAS,CAAa;IACtB,0MAA0M;IAC1M,+BAA+B,CAAU;CAC1C;AATD,8DASC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** @description An object detailing the inner packaging of the dangerous good. */
|
|
2
|
+
export declare class DangerousGoodsInnerPackaging {
|
|
3
|
+
/** @description The type of inner packaging used (e.g., "Glass Bottle", "Plastic Jar", "Metal Can"). */
|
|
4
|
+
type?: string;
|
|
5
|
+
/** @description The number of individual inner packagings contained within the outer package for this specific dangerous good. */
|
|
6
|
+
quantity?: number;
|
|
7
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DangerousGoodsInnerPackaging = void 0;
|
|
4
|
+
/** @description An object detailing the inner packaging of the dangerous good. */
|
|
5
|
+
class DangerousGoodsInnerPackaging {
|
|
6
|
+
/** @description The type of inner packaging used (e.g., "Glass Bottle", "Plastic Jar", "Metal Can"). */
|
|
7
|
+
type;
|
|
8
|
+
/** @description The number of individual inner packagings contained within the outer package for this specific dangerous good. */
|
|
9
|
+
quantity;
|
|
10
|
+
}
|
|
11
|
+
exports.DangerousGoodsInnerPackaging = DangerousGoodsInnerPackaging;
|
|
12
|
+
//# sourceMappingURL=dangerous-goods-inner-packaging.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dangerous-goods-inner-packaging.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods-inner-packaging.ts"],"names":[],"mappings":";;;AAAA,kFAAkF;AAClF,MAAa,4BAA4B;IACvC,wGAAwG;IACxG,IAAI,CAAU;IACd,kIAAkI;IAClI,QAAQ,CAAU;CACnB;AALD,oEAKC"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { RegulationLevelTypes } from './regulation-level-types';
|
|
2
|
+
import { TransportMeanTypes } from './transport-mean-types';
|
|
3
|
+
/** @description An object containing information specific to the dangerous goods aspects of an individual package. */
|
|
4
|
+
export declare class DangerousGoodsPackageInfo {
|
|
5
|
+
/** @description Transportation means through which the dangerous goods are transported */
|
|
6
|
+
transport_mean?: TransportMeanTypes;
|
|
7
|
+
/** @description Indicates whether the dangerous goods package must be accessible during transit for inspection or handling. true if accessible, false otherwise. */
|
|
8
|
+
accessibility?: boolean;
|
|
9
|
+
/** @description Specifies if the package is an overpack, meaning it contains one or more packages prepared in accordance with dangerous goods regulations. true if it is an overpack, false otherwise. */
|
|
10
|
+
is_overpack?: boolean;
|
|
11
|
+
/** @description Indicates whether all dangerous goods in the package are packed in accordance with the same regulations. True if all packed in one, false otherwise. */
|
|
12
|
+
all_packed_in_one?: boolean;
|
|
13
|
+
/** @description The "Q" value, a calculated value used in certain dangerous goods regulations (e.g., IATA) to determine if a package is compliant with quantity limits in mixed packing scenarios. Can be null if not applicable. */
|
|
14
|
+
q_value?: number;
|
|
15
|
+
/** @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
|
+
outer_packaging_type?: string;
|
|
17
|
+
/** @description Regulation level of the dangerous goods */
|
|
18
|
+
regulation_level?: RegulationLevelTypes;
|
|
19
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DangerousGoodsPackageInfo = void 0;
|
|
4
|
+
/** @description An object containing information specific to the dangerous goods aspects of an individual package. */
|
|
5
|
+
class DangerousGoodsPackageInfo {
|
|
6
|
+
/** @description Transportation means through which the dangerous goods are transported */
|
|
7
|
+
transport_mean;
|
|
8
|
+
/** @description Indicates whether the dangerous goods package must be accessible during transit for inspection or handling. true if accessible, false otherwise. */
|
|
9
|
+
accessibility;
|
|
10
|
+
/** @description Specifies if the package is an overpack, meaning it contains one or more packages prepared in accordance with dangerous goods regulations. true if it is an overpack, false otherwise. */
|
|
11
|
+
is_overpack;
|
|
12
|
+
/** @description Indicates whether all dangerous goods in the package are packed in accordance with the same regulations. True if all packed in one, false otherwise. */
|
|
13
|
+
all_packed_in_one;
|
|
14
|
+
/** @description The "Q" value, a calculated value used in certain dangerous goods regulations (e.g., IATA) to determine if a package is compliant with quantity limits in mixed packing scenarios. Can be null if not applicable. */
|
|
15
|
+
q_value;
|
|
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). */
|
|
17
|
+
outer_packaging_type;
|
|
18
|
+
/** @description Regulation level of the dangerous goods */
|
|
19
|
+
regulation_level;
|
|
20
|
+
}
|
|
21
|
+
exports.DangerousGoodsPackageInfo = DangerousGoodsPackageInfo;
|
|
22
|
+
//# sourceMappingURL=dangerous-goods-package-info.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dangerous-goods-package-info.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods-package-info.ts"],"names":[],"mappings":";;;AAGA,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,CAAwB;CACzC;AAfD,8DAeC"}
|
|
@@ -4,6 +4,7 @@ import { RegulationLevelTypes } from './regulation-level-types';
|
|
|
4
4
|
import { TransportMeanTypes } from './transport-mean-types';
|
|
5
5
|
import { DangerousAmountDetails } from './weight-details';
|
|
6
6
|
import { AccessibilityTypes } from '../accessibility-types';
|
|
7
|
+
import { DangerousGoodsInnerPackaging } from './dangerous-goods-inner-packaging';
|
|
7
8
|
/** @description Basic structure for a dangerous goods */
|
|
8
9
|
export declare class DangerousGoods {
|
|
9
10
|
/** @description UN number to identify the dangerous goods */
|
|
@@ -46,4 +47,8 @@ export declare class DangerousGoods {
|
|
|
46
47
|
additional_description?: string;
|
|
47
48
|
/** @description Identifies whatever the product being shipped is accessible or inaccessible during delivery.*/
|
|
48
49
|
accessibility?: AccessibilityTypes;
|
|
50
|
+
/** @description A comma-separated list of special provisions (e.g., "A88, A183") that apply to the specific dangerous good as defined by the relevant dangerous goods regulations. These provisions may modify or clarify the general requirements. */
|
|
51
|
+
special_provisions?: string;
|
|
52
|
+
/** @description An object detailing the inner packaging of the dangerous good. */
|
|
53
|
+
inner_packaging?: DangerousGoodsInnerPackaging;
|
|
49
54
|
}
|
|
@@ -43,6 +43,10 @@ class DangerousGoods {
|
|
|
43
43
|
additional_description;
|
|
44
44
|
/** @description Identifies whatever the product being shipped is accessible or inaccessible during delivery.*/
|
|
45
45
|
accessibility;
|
|
46
|
+
/** @description A comma-separated list of special provisions (e.g., "A88, A183") that apply to the specific dangerous good as defined by the relevant dangerous goods regulations. These provisions may modify or clarify the general requirements. */
|
|
47
|
+
special_provisions;
|
|
48
|
+
/** @description An object detailing the inner packaging of the dangerous good. */
|
|
49
|
+
inner_packaging;
|
|
46
50
|
}
|
|
47
51
|
exports.DangerousGoods = DangerousGoods;
|
|
48
52
|
//# sourceMappingURL=dangerous-goods.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dangerous-goods.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"dangerous-goods.js","sourceRoot":"","sources":["../../../src/models/dangerous-good/dangerous-goods.ts"],"names":[],"mappings":";;;AAQA,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;IAChC,+GAA+G;IAC/G,aAAa,CAAsB;IACnC,uPAAuP;IACvP,kBAAkB,CAAU;IAC5B,kFAAkF;IAClF,eAAe,CAAgC;CAChD;AA7CD,wCA6CC"}
|
package/lib/models/package.d.ts
CHANGED
|
@@ -4,6 +4,7 @@ import { Currency } from './currency';
|
|
|
4
4
|
import { LabelMessage } from './labels/label-message';
|
|
5
5
|
import { Customs } from './customs';
|
|
6
6
|
import { Products } from './products';
|
|
7
|
+
import { DangerousGoodsPackageInfo } from './dangerous-good/dangerous-goods-package-info';
|
|
7
8
|
/** @description Basic structure for a package */
|
|
8
9
|
export declare class Package {
|
|
9
10
|
/** @description Package code defined for the carrier in ShipEngine. */
|
|
@@ -22,4 +23,6 @@ export declare class Package {
|
|
|
22
23
|
customs?: Customs;
|
|
23
24
|
/** @description List of products goods model associated with this package passed to the carrier. */
|
|
24
25
|
products?: Products[];
|
|
26
|
+
/** @description An object containing information specific to the dangerous goods aspects of an individual package. */
|
|
27
|
+
dangerous_goods_package_info?: DangerousGoodsPackageInfo;
|
|
25
28
|
}
|
package/lib/models/package.js
CHANGED
|
@@ -19,6 +19,8 @@ class Package {
|
|
|
19
19
|
customs;
|
|
20
20
|
/** @description List of products goods model associated with this package passed to the carrier. */
|
|
21
21
|
products;
|
|
22
|
+
/** @description An object containing information specific to the dangerous goods aspects of an individual package. */
|
|
23
|
+
dangerous_goods_package_info;
|
|
22
24
|
}
|
|
23
25
|
exports.Package = Package;
|
|
24
26
|
//# sourceMappingURL=package.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"package.js","sourceRoot":"","sources":["../../src/models/package.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"package.js","sourceRoot":"","sources":["../../src/models/package.ts"],"names":[],"mappings":";;;AAQA,iDAAiD;AACjD,MAAa,OAAO;IAClB,uEAAuE;IACvE,YAAY,CAAU;IACtB,sIAAsI;IACtI,mBAAmB,CAAU;IAC7B,+DAA+D;IAC/D,iBAAiB,CAAoB;IACrC,2DAA2D;IAC3D,cAAc,CAAiB;IAC/B,sDAAsD;IACtD,aAAa,CAAY;IACzB,2EAA2E;IAC3E,cAAc,CAAgB;IAC9B,0KAA0K;IAC1K,OAAO,CAAW;IAClB,oGAAoG;IACpG,QAAQ,CAAc;IACtB,sHAAsH;IACtH,4BAA4B,CAA6B;CAC1D;AAnBD,0BAmBC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { BaseRequest } from './base-request';
|
|
2
2
|
import { AdvancedOptions, ConfirmationTypes, FulfillmentPlanDetails, InsuranceProviders, DocumentFormat, LabelLayouts, Package, ReturnLabelDetails, ShipFrom, PudoLocation, ShipFromDisplay, ShipTo, Document, TimeWindow, RelayPointDetails, DisplayScheme, Customs, BillTo } from '../models';
|
|
3
|
+
import { DangerousGoodsDeclaration } from '../models/dangerous-good/dangerous-goods-declaration';
|
|
3
4
|
/** @description Basic structure for a request to create a label */
|
|
4
5
|
export declare class CreateLabelRequest extends BaseRequest {
|
|
5
6
|
service_code?: string;
|
|
@@ -38,4 +39,6 @@ export declare class CreateLabelRequest extends BaseRequest {
|
|
|
38
39
|
customs?: Customs;
|
|
39
40
|
/** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */
|
|
40
41
|
bill_shipping_to?: BillTo;
|
|
42
|
+
/** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
|
|
43
|
+
dangerous_goods_declaration?: DangerousGoodsDeclaration;
|
|
41
44
|
}
|
|
@@ -40,6 +40,8 @@ class CreateLabelRequest extends base_request_1.BaseRequest {
|
|
|
40
40
|
customs;
|
|
41
41
|
/** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */
|
|
42
42
|
bill_shipping_to;
|
|
43
|
+
/** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
|
|
44
|
+
dangerous_goods_declaration;
|
|
43
45
|
}
|
|
44
46
|
exports.CreateLabelRequest = CreateLabelRequest;
|
|
45
47
|
//# sourceMappingURL=create-label-request.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"create-label-request.js","sourceRoot":"","sources":["../../src/requests/create-label-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;
|
|
1
|
+
{"version":3,"file":"create-label-request.js","sourceRoot":"","sources":["../../src/requests/create-label-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAuB7C,mEAAmE;AACnE,MAAa,kBAAmB,SAAQ,0BAAW;IACjD,YAAY,CAAU;IACtB,aAAa,CAAU;IACvB,YAAY,CAAqB;IACjC,YAAY,CAAkB;IAC9B,YAAY,CAAgB;IAC5B,qDAAqD;IACrD,aAAa,CAAW;IACxB,2FAA2F;IAC3F,gBAAgB,CAAmB;IACnC,kBAAkB,CAAsB;IACxC,oDAAoD;IACpD,eAAe,CAAW;IAC1B,QAAQ,CAAa;IACrB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,gBAAgB,CAAgB;IAChC,eAAe,CAAgB;IAC/B,YAAY,CAAqB;IACjC,iBAAiB,CAAmB;IACpC,mEAAmE;IACnE,QAAQ,CAAW;IACnB,yDAAyD;IACzD,aAAa,CAAW;IACxB,SAAS,CAAU;IACnB,cAAc,CAAsB;IACpC,wBAAwB,CAA0B;IAClD,WAAW,CAAc;IACzB,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0DAA0D;IAC1D,eAAe,CAAU;IACzB,oGAAoG;IACpG,eAAe,CAAmB;IAClC,OAAO,CAAW;IAClB,kJAAkJ;IAClJ,gBAAgB,CAAU;IAC1B,8HAA8H;IAC9H,2BAA2B,CAA6B;CACzD;AAvCD,gDAuCC"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { BaseRequest } from './base-request';
|
|
2
2
|
import { ConfirmationTypes, AdvancedOptions, InsuranceProviders, Package, Customs, ShipFrom, ShipTo, PudoLocation, FulfillmentPlanDetails, TimeWindow, BillTo, DisplayScheme } from '../models';
|
|
3
3
|
import { ShipmentItem } from '../models/shipment-item';
|
|
4
|
+
import { DangerousGoodsDeclaration } from '../models/dangerous-good/dangerous-goods-declaration';
|
|
4
5
|
/** @description Basic structure for a request to get rates */
|
|
5
6
|
export declare class GetRatesRequest extends BaseRequest {
|
|
6
7
|
service_code?: string;
|
|
@@ -25,4 +26,6 @@ export declare class GetRatesRequest extends BaseRequest {
|
|
|
25
26
|
bill_shipping_to?: BillTo;
|
|
26
27
|
/** @description Display schemes in which the rate will be evaluated. Labels are used by default. */
|
|
27
28
|
display_schemes?: DisplayScheme[];
|
|
29
|
+
/** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
|
|
30
|
+
dangerous_goods_declaration?: DangerousGoodsDeclaration;
|
|
28
31
|
}
|
|
@@ -26,6 +26,8 @@ class GetRatesRequest extends base_request_1.BaseRequest {
|
|
|
26
26
|
bill_shipping_to;
|
|
27
27
|
/** @description Display schemes in which the rate will be evaluated. Labels are used by default. */
|
|
28
28
|
display_schemes;
|
|
29
|
+
/** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
|
|
30
|
+
dangerous_goods_declaration;
|
|
29
31
|
}
|
|
30
32
|
exports.GetRatesRequest = GetRatesRequest;
|
|
31
33
|
//# sourceMappingURL=get-rates-request.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"get-rates-request.js","sourceRoot":"","sources":["../../src/requests/get-rates-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;
|
|
1
|
+
{"version":3,"file":"get-rates-request.js","sourceRoot":"","sources":["../../src/requests/get-rates-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAkB7C,8DAA8D;AAC9D,MAAa,eAAgB,SAAQ,0BAAW;IAC9C,YAAY,CAAU;IACtB,aAAa,CAAU;IACvB,YAAY,CAAqB;IACjC,gBAAgB,CAAmB;IACnC,kBAAkB,CAAsB;IACxC,eAAe,CAAW;IAC1B,QAAQ,CAAa;IACrB,OAAO,CAAW;IAClB,OAAO,CAAU;IACjB,SAAS,CAAY;IACrB,eAAe,CAAgB;IAC/B,aAAa,CAAW;IACxB,QAAQ,CAAW;IACnB,wBAAwB,CAA0B;IAClD,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,qCAAqC;IACrC,KAAK,CAAkB;IACvB,kJAAkJ;IAClJ,gBAAgB,CAAU;IAC1B,oGAAoG;IACpG,eAAe,CAAmB;IAClC,8HAA8H;IAC9H,2BAA2B,CAA6B;CACzD;AAzBD,0CAyBC"}
|
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.28.
|
|
6
|
+
"version": "1.28.2"
|
|
7
7
|
},
|
|
8
8
|
"paths": {
|
|
9
9
|
"/Register": {
|
|
@@ -1407,8 +1407,11 @@
|
|
|
1407
1407
|
},
|
|
1408
1408
|
"description": "Display schemes that the label will be returned in. Label is returned by default",
|
|
1409
1409
|
"nullable": true
|
|
1410
|
+
},
|
|
1411
|
+
"dangerous_goods_declaration": {
|
|
1412
|
+
"$ref": "#/components/schemas/DangerousGoodsDeclaration"
|
|
1410
1413
|
}
|
|
1411
|
-
},
|
|
1414
|
+
},
|
|
1412
1415
|
"additionalProperties": false
|
|
1413
1416
|
},
|
|
1414
1417
|
"CreateLabelResponse": {
|
|
@@ -2000,6 +2003,15 @@
|
|
|
2000
2003
|
},
|
|
2001
2004
|
"accessibility": {
|
|
2002
2005
|
"$ref": "#/components/schemas/AccessibilityTypes"
|
|
2006
|
+
},
|
|
2007
|
+
"special_provisions": {
|
|
2008
|
+
"type": "string",
|
|
2009
|
+
"description": "A comma-separated list of special provisions that apply to the specific dangerous good as defined by the relevant dangerous goods regulations. These provisions may modify or clarify the general requirements.",
|
|
2010
|
+
"nullable": true,
|
|
2011
|
+
"example": "A88, A183"
|
|
2012
|
+
},
|
|
2013
|
+
"inner_packaging": {
|
|
2014
|
+
"$ref": "#/components/schemas/DangerousGoodsInnerPackaging"
|
|
2003
2015
|
}
|
|
2004
2016
|
},
|
|
2005
2017
|
"additionalProperties": false,
|
|
@@ -2022,6 +2034,87 @@
|
|
|
2022
2034
|
"additionalProperties": false,
|
|
2023
2035
|
"description": "This model represents contact information regarding dangerous goods"
|
|
2024
2036
|
},
|
|
2037
|
+
"DangerousGoodsDeclaration": {
|
|
2038
|
+
"type": "object",
|
|
2039
|
+
"properties": {
|
|
2040
|
+
"regulation_set": {
|
|
2041
|
+
"type": "string",
|
|
2042
|
+
"description": "Name of the regulatory authority.",
|
|
2043
|
+
"nullable": true
|
|
2044
|
+
},
|
|
2045
|
+
"emergency_contact": {
|
|
2046
|
+
"$ref": "#/components/schemas/DangerousGoodsContact"
|
|
2047
|
+
},
|
|
2048
|
+
"signatory": {
|
|
2049
|
+
"$ref": "#/components/schemas/Signatory"
|
|
2050
|
+
},
|
|
2051
|
+
"additional_handling_information": {
|
|
2052
|
+
"type": "string",
|
|
2053
|
+
"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.",
|
|
2054
|
+
"nullable": true
|
|
2055
|
+
}
|
|
2056
|
+
},
|
|
2057
|
+
"additionalProperties": false,
|
|
2058
|
+
"description": "An object containing high-level information about the dangerous goods declaration for the entire shipment."
|
|
2059
|
+
},
|
|
2060
|
+
"DangerousGoodsInnerPackaging": {
|
|
2061
|
+
"type": "object",
|
|
2062
|
+
"properties": {
|
|
2063
|
+
"type": {
|
|
2064
|
+
"type": "string",
|
|
2065
|
+
"description": "The type of inner packaging used.",
|
|
2066
|
+
"nullable": true,
|
|
2067
|
+
"example": "Glass Bottle, Plastic Jar, Metal Can"
|
|
2068
|
+
},
|
|
2069
|
+
"quantity": {
|
|
2070
|
+
"type": "number",
|
|
2071
|
+
"description": "An object detailing the inner packaging of the dangerous good.",
|
|
2072
|
+
"format": "double",
|
|
2073
|
+
"nullable": true
|
|
2074
|
+
}
|
|
2075
|
+
},
|
|
2076
|
+
"additionalProperties": false,
|
|
2077
|
+
"description": "An object detailing the inner packaging of the dangerous good."
|
|
2078
|
+
},
|
|
2079
|
+
"DangerousGoodsPackageInfo": {
|
|
2080
|
+
"type": "object",
|
|
2081
|
+
"properties": {
|
|
2082
|
+
"transport_mean": {
|
|
2083
|
+
"$ref": "#/components/schemas/TransportMeanEnum"
|
|
2084
|
+
},
|
|
2085
|
+
"accessibility": {
|
|
2086
|
+
"type": "boolean",
|
|
2087
|
+
"description": "Indicates whether the dangerous goods package must be accessible during transit for inspection or handling. True if accessible, false otherwise.",
|
|
2088
|
+
"nullable": true
|
|
2089
|
+
},
|
|
2090
|
+
"is_overpack": {
|
|
2091
|
+
"type": "boolean",
|
|
2092
|
+
"description": "Specifies if the package is an overpack, meaning it contains one or more packages prepared in accordance with dangerous goods regulations. True if it is an overpack, false otherwise.",
|
|
2093
|
+
"nullable": true
|
|
2094
|
+
},
|
|
2095
|
+
"all_packed_in_one": {
|
|
2096
|
+
"type": "boolean",
|
|
2097
|
+
"description": "Indicates whether all dangerous goods in the package are packed in accordance with the same regulations. True if all packed in one, false otherwise.",
|
|
2098
|
+
"nullable": true
|
|
2099
|
+
},
|
|
2100
|
+
"q_value": {
|
|
2101
|
+
"type": "number",
|
|
2102
|
+
"description": "The 'Q' value, a calculated value used in certain dangerous goods regulations (e.g., IATA) to determine if a package is compliant with quantity limits in mixed packing scenarios. Can be null if not applicable.",
|
|
2103
|
+
"nullable": true
|
|
2104
|
+
},
|
|
2105
|
+
"outer_packaging_type": {
|
|
2106
|
+
"type": "string",
|
|
2107
|
+
"description": "The type of outer packaging used for the dangerous goods package, typically represented by a UN packaging code.",
|
|
2108
|
+
"nullable": true,
|
|
2109
|
+
"example": "'4G' for fiberboard box, '1A2' for steel drum"
|
|
2110
|
+
},
|
|
2111
|
+
"regulation_level": {
|
|
2112
|
+
"$ref": "#/components/schemas/RegulationLevelEnum"
|
|
2113
|
+
}
|
|
2114
|
+
},
|
|
2115
|
+
"additionalProperties": false,
|
|
2116
|
+
"description": "An object containing information specific to the dangerous goods aspects of an individual package."
|
|
2117
|
+
},
|
|
2025
2118
|
"DayOfOperation": {
|
|
2026
2119
|
"type": "object",
|
|
2027
2120
|
"properties": {
|
|
@@ -2420,6 +2513,9 @@
|
|
|
2420
2513
|
},
|
|
2421
2514
|
"description": "Display schemes in which the rate will be evaluated. Labels are used by default.",
|
|
2422
2515
|
"nullable": true
|
|
2516
|
+
},
|
|
2517
|
+
"dangerous_goods_declaration": {
|
|
2518
|
+
"$ref": "#/components/schemas/DangerousGoodsDeclaration"
|
|
2423
2519
|
}
|
|
2424
2520
|
},
|
|
2425
2521
|
"additionalProperties": false,
|
|
@@ -3162,6 +3258,9 @@
|
|
|
3162
3258
|
},
|
|
3163
3259
|
"description": "List of products associated with this package.",
|
|
3164
3260
|
"nullable": true
|
|
3261
|
+
},
|
|
3262
|
+
"dangerous_goods_package_info": {
|
|
3263
|
+
"$ref": "#/components/schemas/DangerousGoodsPackageInfo"
|
|
3165
3264
|
}
|
|
3166
3265
|
},
|
|
3167
3266
|
"additionalProperties": false,
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { Signatory } from '../signatory';
|
|
2
|
+
import { DangerousGoodsContact } from './dangerous-goods-contact';
|
|
3
|
+
|
|
4
|
+
/** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
|
|
5
|
+
export class DangerousGoodsDeclaration {
|
|
6
|
+
/** @description Name of the regulatory authority */
|
|
7
|
+
regulation_set?: string;
|
|
8
|
+
/** @description Contact information for Dangerous goods */
|
|
9
|
+
emergency_contact?: DangerousGoodsContact;
|
|
10
|
+
/** @description An object containing details of the person signing the dangerous goods declaration. */
|
|
11
|
+
signatory?: Signatory;
|
|
12
|
+
/** @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
|
+
additional_handling_information?: string;
|
|
14
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** @description An object detailing the inner packaging of the dangerous good. */
|
|
2
|
+
export class DangerousGoodsInnerPackaging {
|
|
3
|
+
/** @description The type of inner packaging used (e.g., "Glass Bottle", "Plastic Jar", "Metal Can"). */
|
|
4
|
+
type?: string;
|
|
5
|
+
/** @description The number of individual inner packagings contained within the outer package for this specific dangerous good. */
|
|
6
|
+
quantity?: number;
|
|
7
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { RegulationLevelTypes } from './regulation-level-types';
|
|
2
|
+
import { TransportMeanTypes } from './transport-mean-types';
|
|
3
|
+
|
|
4
|
+
/** @description An object containing information specific to the dangerous goods aspects of an individual package. */
|
|
5
|
+
export class DangerousGoodsPackageInfo {
|
|
6
|
+
/** @description Transportation means through which the dangerous goods are transported */
|
|
7
|
+
transport_mean?: TransportMeanTypes;
|
|
8
|
+
/** @description Indicates whether the dangerous goods package must be accessible during transit for inspection or handling. true if accessible, false otherwise. */
|
|
9
|
+
accessibility?: boolean;
|
|
10
|
+
/** @description Specifies if the package is an overpack, meaning it contains one or more packages prepared in accordance with dangerous goods regulations. true if it is an overpack, false otherwise. */
|
|
11
|
+
is_overpack?: boolean;
|
|
12
|
+
/** @description Indicates whether all dangerous goods in the package are packed in accordance with the same regulations. True if all packed in one, false otherwise. */
|
|
13
|
+
all_packed_in_one?: boolean;
|
|
14
|
+
/** @description The "Q" value, a calculated value used in certain dangerous goods regulations (e.g., IATA) to determine if a package is compliant with quantity limits in mixed packing scenarios. Can be null if not applicable. */
|
|
15
|
+
q_value?: number;
|
|
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). */
|
|
17
|
+
outer_packaging_type?: string;
|
|
18
|
+
/** @description Regulation level of the dangerous goods */
|
|
19
|
+
regulation_level?: RegulationLevelTypes;
|
|
20
|
+
}
|
|
@@ -4,6 +4,7 @@ import { RegulationLevelTypes } from './regulation-level-types';
|
|
|
4
4
|
import { TransportMeanTypes } from './transport-mean-types';
|
|
5
5
|
import { DangerousAmountDetails } from './weight-details';
|
|
6
6
|
import { AccessibilityTypes } from '../accessibility-types';
|
|
7
|
+
import { DangerousGoodsInnerPackaging } from './dangerous-goods-inner-packaging';
|
|
7
8
|
|
|
8
9
|
/** @description Basic structure for a dangerous goods */
|
|
9
10
|
export class DangerousGoods {
|
|
@@ -47,4 +48,8 @@ export class DangerousGoods {
|
|
|
47
48
|
additional_description?: string;
|
|
48
49
|
/** @description Identifies whatever the product being shipped is accessible or inaccessible during delivery.*/
|
|
49
50
|
accessibility?: AccessibilityTypes;
|
|
51
|
+
/** @description A comma-separated list of special provisions (e.g., "A88, A183") that apply to the specific dangerous good as defined by the relevant dangerous goods regulations. These provisions may modify or clarify the general requirements. */
|
|
52
|
+
special_provisions?: string;
|
|
53
|
+
/** @description An object detailing the inner packaging of the dangerous good. */
|
|
54
|
+
inner_packaging?: DangerousGoodsInnerPackaging;
|
|
50
55
|
}
|
package/src/models/package.ts
CHANGED
|
@@ -4,6 +4,7 @@ import { Currency } from './currency';
|
|
|
4
4
|
import { LabelMessage } from './labels/label-message';
|
|
5
5
|
import { Customs } from './customs';
|
|
6
6
|
import { Products } from './products';
|
|
7
|
+
import { DangerousGoodsPackageInfo } from './dangerous-good/dangerous-goods-package-info';
|
|
7
8
|
|
|
8
9
|
/** @description Basic structure for a package */
|
|
9
10
|
export class Package {
|
|
@@ -23,4 +24,6 @@ export class Package {
|
|
|
23
24
|
customs?: Customs;
|
|
24
25
|
/** @description List of products goods model associated with this package passed to the carrier. */
|
|
25
26
|
products?: Products[];
|
|
27
|
+
/** @description An object containing information specific to the dangerous goods aspects of an individual package. */
|
|
28
|
+
dangerous_goods_package_info?: DangerousGoodsPackageInfo;
|
|
26
29
|
}
|
|
@@ -19,6 +19,7 @@ import {
|
|
|
19
19
|
Customs,
|
|
20
20
|
BillTo,
|
|
21
21
|
} from '../models';
|
|
22
|
+
import { DangerousGoodsDeclaration } from '../models/dangerous-good/dangerous-goods-declaration';
|
|
22
23
|
|
|
23
24
|
/** @description Basic structure for a request to create a label */
|
|
24
25
|
export class CreateLabelRequest extends BaseRequest {
|
|
@@ -58,4 +59,6 @@ export class CreateLabelRequest extends BaseRequest {
|
|
|
58
59
|
customs?: Customs;
|
|
59
60
|
/** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */
|
|
60
61
|
bill_shipping_to?: BillTo;
|
|
62
|
+
/** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
|
|
63
|
+
dangerous_goods_declaration?: DangerousGoodsDeclaration;
|
|
61
64
|
}
|
|
@@ -14,6 +14,7 @@ import {
|
|
|
14
14
|
DisplayScheme,
|
|
15
15
|
} from '../models';
|
|
16
16
|
import { ShipmentItem } from '../models/shipment-item';
|
|
17
|
+
import { DangerousGoodsDeclaration } from '../models/dangerous-good/dangerous-goods-declaration';
|
|
17
18
|
|
|
18
19
|
/** @description Basic structure for a request to get rates */
|
|
19
20
|
export class GetRatesRequest extends BaseRequest {
|
|
@@ -39,4 +40,6 @@ export class GetRatesRequest extends BaseRequest {
|
|
|
39
40
|
bill_shipping_to?: BillTo;
|
|
40
41
|
/** @description Display schemes in which the rate will be evaluated. Labels are used by default. */
|
|
41
42
|
display_schemes?: DisplayScheme[];
|
|
43
|
+
/** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
|
|
44
|
+
dangerous_goods_declaration?: DangerousGoodsDeclaration;
|
|
42
45
|
}
|