@shipengine/connect-carrier-api 4.20.0 → 4.22.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/confirmation-type.d.ts +2 -1
- package/lib/app/metadata/confirmation-type.js +2 -0
- package/lib/app/metadata/confirmation-type.js.map +1 -1
- package/lib/app/metadata/shipping-option.d.ts +9 -1
- package/lib/app/metadata/shipping-option.js +8 -0
- package/lib/app/metadata/shipping-option.js.map +1 -1
- package/lib/models/advanced-options.d.ts +16 -1
- package/lib/models/advanced-options.js +15 -1
- package/lib/models/advanced-options.js.map +1 -1
- package/lib/models/customer-expected-delivery/customer-expected-delivery.d.ts +7 -0
- package/lib/models/customer-expected-delivery/customer-expected-delivery.js +12 -0
- package/lib/models/customer-expected-delivery/customer-expected-delivery.js.map +1 -0
- package/package.json +2 -2
- package/spec.json +82 -6
- package/src/app/metadata/confirmation-type.ts +2 -0
- package/src/app/metadata/shipping-option.ts +8 -0
- package/src/models/advanced-options.ts +16 -1
- package/src/models/customer-expected-delivery/customer-expected-delivery.ts +7 -0
- package/tsconfig.tsbuildinfo +1 -1
|
@@ -13,7 +13,8 @@ export declare enum ConfirmationTypeEnum {
|
|
|
13
13
|
Signature = "Signature",
|
|
14
14
|
AdultSignature = "AdultSignature",
|
|
15
15
|
DirectSignature = "DirectSignature",
|
|
16
|
-
DeliveryCode = "DeliveryCode"
|
|
16
|
+
DeliveryCode = "DeliveryCode",
|
|
17
|
+
AgeVerification16Plus = "AgeVerification16Plus"
|
|
17
18
|
}
|
|
18
19
|
export declare const ConfirmationTypeEnumSchema: Joi.StringSchema;
|
|
19
20
|
export declare const ConfirmationTypeSchema: Joi.ObjectSchema<any>;
|
|
@@ -10,6 +10,7 @@ exports.ConfirmationDictionarySchema = joi_1.default.object({
|
|
|
10
10
|
AdultSignature: joi_1.default.string().optional(),
|
|
11
11
|
DirectSignature: joi_1.default.string().optional(),
|
|
12
12
|
DeliveryCode: joi_1.default.string().optional(),
|
|
13
|
+
AgeVerification16Plus: joi_1.default.string().optional(),
|
|
13
14
|
});
|
|
14
15
|
var ConfirmationTypeEnum;
|
|
15
16
|
(function (ConfirmationTypeEnum) {
|
|
@@ -19,6 +20,7 @@ var ConfirmationTypeEnum;
|
|
|
19
20
|
ConfirmationTypeEnum["AdultSignature"] = "AdultSignature";
|
|
20
21
|
ConfirmationTypeEnum["DirectSignature"] = "DirectSignature";
|
|
21
22
|
ConfirmationTypeEnum["DeliveryCode"] = "DeliveryCode";
|
|
23
|
+
ConfirmationTypeEnum["AgeVerification16Plus"] = "AgeVerification16Plus";
|
|
22
24
|
})(ConfirmationTypeEnum || (exports.ConfirmationTypeEnum = ConfirmationTypeEnum = {}));
|
|
23
25
|
exports.ConfirmationTypeEnumSchema = joi_1.default.string().valid(...Object.values(ConfirmationTypeEnum));
|
|
24
26
|
exports.ConfirmationTypeSchema = joi_1.default.object({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"confirmation-type.js","sourceRoot":"","sources":["../../../src/app/metadata/confirmation-type.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAWT,QAAA,4BAA4B,GAAG,aAAG,CAAC,MAAM,CAAC;IACrD,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;
|
|
1
|
+
{"version":3,"file":"confirmation-type.js","sourceRoot":"","sources":["../../../src/app/metadata/confirmation-type.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAWT,QAAA,4BAA4B,GAAG,aAAG,CAAC,MAAM,CAAC;IACrD,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,qBAAqB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/C,CAAC,CAAC;AAEH,IAAY,oBAQX;AARD,WAAY,oBAAoB;IAC9B,qCAAa,CAAA;IACb,6CAAqB,CAAA;IACrB,+CAAuB,CAAA;IACvB,yDAAiC,CAAA;IACjC,2DAAmC,CAAA;IACnC,qDAA6B,CAAA;IAC7B,uEAA+C,CAAA;AACjD,CAAC,EARW,oBAAoB,oCAApB,oBAAoB,QAQ/B;AAEY,QAAA,0BAA0B,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAC1D,GAAG,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CACvC,CAAC;AAEW,QAAA,sBAAsB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,IAAI,EAAE,kCAA0B,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC"}
|
|
@@ -41,6 +41,14 @@ export declare enum ShippingOptionEnum {
|
|
|
41
41
|
CarrierInsurance = "carrier-insurance",
|
|
42
42
|
WindsorFrameworkMovementIndicator = "windsor-framework-movement-indicator",
|
|
43
43
|
WindsorFrameworkNotAtRisk = "windsor-framework-not-at-risk",
|
|
44
|
-
EnableDocumentUpload = "enable-document-upload"
|
|
44
|
+
EnableDocumentUpload = "enable-document-upload",
|
|
45
|
+
Unpack = "unpack",
|
|
46
|
+
PackagingDisposal = "packaging-disposal",
|
|
47
|
+
Assembly = "assembly",
|
|
48
|
+
Disassembly = "disassembly",
|
|
49
|
+
CustomerExpectedDeliveryFromDate = "customer-expected-delivery-from-date",
|
|
50
|
+
CustomerExpectedDeliveryToDate = "customer-expected-delivery-to-date",
|
|
51
|
+
DeliveryAsAddressed = "delivery-as-addressed",
|
|
52
|
+
ReturnAfterFirstAttempt = "return-after-first-attempt"
|
|
45
53
|
}
|
|
46
54
|
export declare const ShippingOptionDictionarySchema: Joi.ObjectSchema<any>;
|
|
@@ -38,6 +38,14 @@ var ShippingOptionEnum;
|
|
|
38
38
|
ShippingOptionEnum["WindsorFrameworkMovementIndicator"] = "windsor-framework-movement-indicator";
|
|
39
39
|
ShippingOptionEnum["WindsorFrameworkNotAtRisk"] = "windsor-framework-not-at-risk";
|
|
40
40
|
ShippingOptionEnum["EnableDocumentUpload"] = "enable-document-upload";
|
|
41
|
+
ShippingOptionEnum["Unpack"] = "unpack";
|
|
42
|
+
ShippingOptionEnum["PackagingDisposal"] = "packaging-disposal";
|
|
43
|
+
ShippingOptionEnum["Assembly"] = "assembly";
|
|
44
|
+
ShippingOptionEnum["Disassembly"] = "disassembly";
|
|
45
|
+
ShippingOptionEnum["CustomerExpectedDeliveryFromDate"] = "customer-expected-delivery-from-date";
|
|
46
|
+
ShippingOptionEnum["CustomerExpectedDeliveryToDate"] = "customer-expected-delivery-to-date";
|
|
47
|
+
ShippingOptionEnum["DeliveryAsAddressed"] = "delivery-as-addressed";
|
|
48
|
+
ShippingOptionEnum["ReturnAfterFirstAttempt"] = "return-after-first-attempt";
|
|
41
49
|
})(ShippingOptionEnum || (exports.ShippingOptionEnum = ShippingOptionEnum = {}));
|
|
42
50
|
exports.ShippingOptionDictionarySchema = joi_1.default.object(Object.values(ShippingOptionEnum).reduce((accumulator, option) => {
|
|
43
51
|
accumulator[option] = exports.ShippingOptionDescriptionSchema;
|
|
@@ -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,kBAsCX;AAtCD,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,mEAA6C,CAAA;IAC7C,4EAAsD,CAAA;AACxD,CAAC,EAtCW,kBAAkB,kCAAlB,kBAAkB,QAsC7B;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"}
|
|
@@ -6,6 +6,7 @@ import { AccessibilityTypes } from './accessibility-types';
|
|
|
6
6
|
import { Signatory } from './signatory';
|
|
7
7
|
import { RegulationLevelTypes } from './dangerous-good/regulation-level-types';
|
|
8
8
|
import { TransportMeanTypes } from './dangerous-good/transport-mean-types';
|
|
9
|
+
import { CustomerExpectedDelivery } from './customer-expected-delivery/customer-expected-delivery';
|
|
9
10
|
/** @description Basic structure for shipping options */
|
|
10
11
|
export declare class AdvancedOptions {
|
|
11
12
|
/** @description Whether the user will upload documents */
|
|
@@ -34,7 +35,7 @@ export declare class AdvancedOptions {
|
|
|
34
35
|
dangerous_goods_contact?: DangerousGoodsContact;
|
|
35
36
|
/** @description Describes the transport of dangerous goods that is restricted to Limited Quantities of Dangerous Goods only */
|
|
36
37
|
limited_quantity?: boolean;
|
|
37
|
-
/** @description
|
|
38
|
+
/** @description Indicates whether the recipient should be notified of events related to the shipment. */
|
|
38
39
|
event_notification?: boolean;
|
|
39
40
|
/** @description Any other custom shipping options */
|
|
40
41
|
windsor_framework_details?: WindsorFrameworkDetails;
|
|
@@ -46,6 +47,20 @@ export declare class AdvancedOptions {
|
|
|
46
47
|
regulation_level?: RegulationLevelTypes;
|
|
47
48
|
/** @description Transportation means through which the dangerous goods are transported */
|
|
48
49
|
transport_mean?: TransportMeanTypes;
|
|
50
|
+
/** @description Indicates whether the carrier should unpack the goods after delivery. */
|
|
51
|
+
unpack?: boolean;
|
|
52
|
+
/** @description Specifies whether the carrier should remove and dispose of the packaging materials after unpacking. */
|
|
53
|
+
packaging_disposal?: boolean;
|
|
54
|
+
/** @description Determines whether assembly of the delivered product is required. */
|
|
55
|
+
assembly?: boolean;
|
|
56
|
+
/** @description Indicates whether disassembly of existing items is required prior to delivery or installation. */
|
|
57
|
+
disassembly?: boolean;
|
|
58
|
+
/** @description The date range when the customer expects the shipment to be delivered. ISO 8601 format */
|
|
59
|
+
customer_expected_delivery?: CustomerExpectedDelivery;
|
|
49
60
|
/** @description Indicates whether the recipient should be notified of events related to the shipment. */
|
|
61
|
+
delivery_as_addressed?: boolean;
|
|
62
|
+
/** @description Instructs the carrier to deliver the package only to the exact address provided. */
|
|
63
|
+
return_after_first_attempt?: boolean;
|
|
64
|
+
/** @description Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails. */
|
|
50
65
|
[key: string]: any;
|
|
51
66
|
}
|
|
@@ -29,7 +29,7 @@ class AdvancedOptions {
|
|
|
29
29
|
dangerous_goods_contact;
|
|
30
30
|
/** @description Describes the transport of dangerous goods that is restricted to Limited Quantities of Dangerous Goods only */
|
|
31
31
|
limited_quantity;
|
|
32
|
-
/** @description
|
|
32
|
+
/** @description Indicates whether the recipient should be notified of events related to the shipment. */
|
|
33
33
|
event_notification;
|
|
34
34
|
/** @description Any other custom shipping options */
|
|
35
35
|
windsor_framework_details;
|
|
@@ -41,6 +41,20 @@ class AdvancedOptions {
|
|
|
41
41
|
regulation_level;
|
|
42
42
|
/** @description Transportation means through which the dangerous goods are transported */
|
|
43
43
|
transport_mean;
|
|
44
|
+
/** @description Indicates whether the carrier should unpack the goods after delivery. */
|
|
45
|
+
unpack;
|
|
46
|
+
/** @description Specifies whether the carrier should remove and dispose of the packaging materials after unpacking. */
|
|
47
|
+
packaging_disposal;
|
|
48
|
+
/** @description Determines whether assembly of the delivered product is required. */
|
|
49
|
+
assembly;
|
|
50
|
+
/** @description Indicates whether disassembly of existing items is required prior to delivery or installation. */
|
|
51
|
+
disassembly;
|
|
52
|
+
/** @description The date range when the customer expects the shipment to be delivered. ISO 8601 format */
|
|
53
|
+
customer_expected_delivery;
|
|
54
|
+
/** @description Indicates whether the recipient should be notified of events related to the shipment. */
|
|
55
|
+
delivery_as_addressed;
|
|
56
|
+
/** @description Instructs the carrier to deliver the package only to the exact address provided. */
|
|
57
|
+
return_after_first_attempt;
|
|
44
58
|
}
|
|
45
59
|
exports.AdvancedOptions = AdvancedOptions;
|
|
46
60
|
//# sourceMappingURL=advanced-options.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"advanced-options.js","sourceRoot":"","sources":["../../src/models/advanced-options.ts"],"names":[],"mappings":";;;
|
|
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;AAvDD,0CAuDC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** @description This model represents the date range when the customer expects the shipment to be delivered. ISO 8601 format */
|
|
2
|
+
export declare class CustomerExpectedDelivery {
|
|
3
|
+
/** @description The beginning of the date range when the customer expects the shipment to be delivered. */
|
|
4
|
+
from_date?: string;
|
|
5
|
+
/** @description The end of the date range when the customer expects the shipment to be delivered. */
|
|
6
|
+
to_date?: string;
|
|
7
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.CustomerExpectedDelivery = void 0;
|
|
4
|
+
/** @description This model represents the date range when the customer expects the shipment to be delivered. ISO 8601 format */
|
|
5
|
+
class CustomerExpectedDelivery {
|
|
6
|
+
/** @description The beginning of the date range when the customer expects the shipment to be delivered. */
|
|
7
|
+
from_date;
|
|
8
|
+
/** @description The end of the date range when the customer expects the shipment to be delivered. */
|
|
9
|
+
to_date;
|
|
10
|
+
}
|
|
11
|
+
exports.CustomerExpectedDelivery = CustomerExpectedDelivery;
|
|
12
|
+
//# sourceMappingURL=customer-expected-delivery.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"customer-expected-delivery.js","sourceRoot":"","sources":["../../../src/models/customer-expected-delivery/customer-expected-delivery.ts"],"names":[],"mappings":";;;AAAA,gIAAgI;AAChI,MAAa,wBAAwB;IACnC,2GAA2G;IAC3G,SAAS,CAAU;IACnB,qGAAqG;IACrG,OAAO,CAAU;CAClB;AALD,4DAKC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shipengine/connect-carrier-api",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.22.0",
|
|
4
4
|
"description": "This is the typescript/javascript definitions for carrier api",
|
|
5
5
|
"homepage": "https://connect.shipengine.com",
|
|
6
6
|
"main": "./lib/index.js",
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
"tslib": "^2.6.2"
|
|
45
45
|
},
|
|
46
46
|
"peerDependencies": {
|
|
47
|
-
"@shipengine/connect-runtime": "^4.10.
|
|
47
|
+
"@shipengine/connect-runtime": "^4.10.3",
|
|
48
48
|
"express": "^4.18.2",
|
|
49
49
|
"winston": "^3.8.2"
|
|
50
50
|
}
|
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.36.0"
|
|
7
7
|
},
|
|
8
8
|
"paths": {
|
|
9
9
|
"/Register": {
|
|
@@ -931,6 +931,32 @@
|
|
|
931
931
|
"enable_document_upload": {
|
|
932
932
|
"type": "boolean",
|
|
933
933
|
"description": "Indicates whether document upload is enabled for the shipment."
|
|
934
|
+
},
|
|
935
|
+
"unpack": {
|
|
936
|
+
"type": "boolean",
|
|
937
|
+
"description": "Indicates whether the carrier should unpack the goods after delivery."
|
|
938
|
+
},
|
|
939
|
+
"packaging_disposal": {
|
|
940
|
+
"type": "boolean",
|
|
941
|
+
"description": "Specifies whether the carrier should remove and dispose of the packaging materials after unpacking."
|
|
942
|
+
},
|
|
943
|
+
"assembly": {
|
|
944
|
+
"type": "boolean",
|
|
945
|
+
"description": "Determines whether assembly of the delivered product is required."
|
|
946
|
+
},
|
|
947
|
+
"disassembly": {
|
|
948
|
+
"type": "boolean",
|
|
949
|
+
"description": "Indicates whether disassembly of existing items is required prior to delivery or installation."
|
|
950
|
+
},
|
|
951
|
+
"customer_expected_delivery": {
|
|
952
|
+
"$ref": "#/components/schemas/CustomerExpectedDelivery"
|
|
953
|
+
},
|
|
954
|
+
"delivery_as_addressed": {
|
|
955
|
+
"type": "boolean"
|
|
956
|
+
},
|
|
957
|
+
"return_after_first_attempt": {
|
|
958
|
+
"type": "boolean",
|
|
959
|
+
"description": "Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails."
|
|
934
960
|
}
|
|
935
961
|
},
|
|
936
962
|
"additionalProperties": { },
|
|
@@ -1353,7 +1379,8 @@
|
|
|
1353
1379
|
"Signature",
|
|
1354
1380
|
"AdultSignature",
|
|
1355
1381
|
"DirectSignature",
|
|
1356
|
-
"DeliveryCode"
|
|
1382
|
+
"DeliveryCode",
|
|
1383
|
+
"AgeVerification16Plus"
|
|
1357
1384
|
],
|
|
1358
1385
|
"type": "string"
|
|
1359
1386
|
},
|
|
@@ -1876,6 +1903,23 @@
|
|
|
1876
1903
|
"additionalProperties": false,
|
|
1877
1904
|
"description": "This model represents the charges related with customs."
|
|
1878
1905
|
},
|
|
1906
|
+
"CustomerExpectedDelivery": {
|
|
1907
|
+
"type": "object",
|
|
1908
|
+
"properties": {
|
|
1909
|
+
"from_date": {
|
|
1910
|
+
"type": "string",
|
|
1911
|
+
"description": "The beginning of the date range when the customer expects the shipment to be delivered. ISO 8601 format",
|
|
1912
|
+
"nullable": true
|
|
1913
|
+
},
|
|
1914
|
+
"to_date": {
|
|
1915
|
+
"type": "string",
|
|
1916
|
+
"description": "The end of the date range when the customer expects the shipment to be delivered. ISO 8601 format",
|
|
1917
|
+
"nullable": true
|
|
1918
|
+
}
|
|
1919
|
+
},
|
|
1920
|
+
"additionalProperties": false,
|
|
1921
|
+
"description": "This model represents the date range when the customer expects the shipment to be delivered"
|
|
1922
|
+
},
|
|
1879
1923
|
"Customs": {
|
|
1880
1924
|
"type": "object",
|
|
1881
1925
|
"properties": {
|
|
@@ -2125,11 +2169,14 @@
|
|
|
2125
2169
|
"DangerousGoodsDeclaration": {
|
|
2126
2170
|
"type": "object",
|
|
2127
2171
|
"properties": {
|
|
2128
|
-
"
|
|
2129
|
-
"type": "
|
|
2130
|
-
"description": "
|
|
2172
|
+
"shipper_declaration": {
|
|
2173
|
+
"type": "boolean",
|
|
2174
|
+
"description": "Shipper declaration",
|
|
2131
2175
|
"nullable": true
|
|
2132
2176
|
},
|
|
2177
|
+
"regulation_set": {
|
|
2178
|
+
"$ref": "#/components/schemas/RegulationSetEnum"
|
|
2179
|
+
},
|
|
2133
2180
|
"emergency_contact": {
|
|
2134
2181
|
"$ref": "#/components/schemas/DangerousGoodsContact"
|
|
2135
2182
|
},
|
|
@@ -2140,6 +2187,11 @@
|
|
|
2140
2187
|
"type": "string",
|
|
2141
2188
|
"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.",
|
|
2142
2189
|
"nullable": true
|
|
2190
|
+
},
|
|
2191
|
+
"contains_alcohol": {
|
|
2192
|
+
"type": "boolean",
|
|
2193
|
+
"description": "Indicates whether the shipment contains alcohol",
|
|
2194
|
+
"nullable": true
|
|
2143
2195
|
}
|
|
2144
2196
|
},
|
|
2145
2197
|
"additionalProperties": false,
|
|
@@ -2196,7 +2248,10 @@
|
|
|
2196
2248
|
"nullable": true
|
|
2197
2249
|
},
|
|
2198
2250
|
"regulation_level": {
|
|
2199
|
-
"$ref": "#/components/schemas/
|
|
2251
|
+
"$ref": "#/components/schemas/RegulationLevelEnumV2"
|
|
2252
|
+
},
|
|
2253
|
+
"dry_ice": {
|
|
2254
|
+
"$ref": "#/components/schemas/CarrierWeight"
|
|
2200
2255
|
}
|
|
2201
2256
|
},
|
|
2202
2257
|
"additionalProperties": false,
|
|
@@ -3986,6 +4041,27 @@
|
|
|
3986
4041
|
],
|
|
3987
4042
|
"type": "string"
|
|
3988
4043
|
},
|
|
4044
|
+
"RegulationLevelEnumV2": {
|
|
4045
|
+
"enum": [
|
|
4046
|
+
"lightly_regulated",
|
|
4047
|
+
"fully_regulated",
|
|
4048
|
+
"limited_quantity",
|
|
4049
|
+
"excepted_quantity"
|
|
4050
|
+
],
|
|
4051
|
+
"type": "string"
|
|
4052
|
+
},
|
|
4053
|
+
"RegulationSetEnum": {
|
|
4054
|
+
"enum": [
|
|
4055
|
+
"iata",
|
|
4056
|
+
"adr",
|
|
4057
|
+
"imdg",
|
|
4058
|
+
"cfr49",
|
|
4059
|
+
"rid",
|
|
4060
|
+
"tdg"
|
|
4061
|
+
],
|
|
4062
|
+
"type": "string",
|
|
4063
|
+
"description": "Name of the regulatory authority for dangerous goods."
|
|
4064
|
+
},
|
|
3989
4065
|
"RelayPoint": {
|
|
3990
4066
|
"required": [
|
|
3991
4067
|
"opening_times",
|
|
@@ -16,6 +16,7 @@ export const ConfirmationDictionarySchema = Joi.object({
|
|
|
16
16
|
AdultSignature: Joi.string().optional(),
|
|
17
17
|
DirectSignature: Joi.string().optional(),
|
|
18
18
|
DeliveryCode: Joi.string().optional(),
|
|
19
|
+
AgeVerification16Plus: Joi.string().optional(),
|
|
19
20
|
});
|
|
20
21
|
|
|
21
22
|
export enum ConfirmationTypeEnum {
|
|
@@ -25,6 +26,7 @@ export enum ConfirmationTypeEnum {
|
|
|
25
26
|
AdultSignature = 'AdultSignature',
|
|
26
27
|
DirectSignature = 'DirectSignature',
|
|
27
28
|
DeliveryCode = 'DeliveryCode',
|
|
29
|
+
AgeVerification16Plus = 'AgeVerification16Plus',
|
|
28
30
|
}
|
|
29
31
|
|
|
30
32
|
export const ConfirmationTypeEnumSchema = Joi.string().valid(
|
|
@@ -45,6 +45,14 @@ export enum ShippingOptionEnum {
|
|
|
45
45
|
WindsorFrameworkMovementIndicator = 'windsor-framework-movement-indicator',
|
|
46
46
|
WindsorFrameworkNotAtRisk = 'windsor-framework-not-at-risk',
|
|
47
47
|
EnableDocumentUpload = 'enable-document-upload',
|
|
48
|
+
Unpack = 'unpack',
|
|
49
|
+
PackagingDisposal = 'packaging-disposal',
|
|
50
|
+
Assembly = 'assembly',
|
|
51
|
+
Disassembly = 'disassembly',
|
|
52
|
+
CustomerExpectedDeliveryFromDate = 'customer-expected-delivery-from-date',
|
|
53
|
+
CustomerExpectedDeliveryToDate = 'customer-expected-delivery-to-date',
|
|
54
|
+
DeliveryAsAddressed = 'delivery-as-addressed',
|
|
55
|
+
ReturnAfterFirstAttempt = 'return-after-first-attempt',
|
|
48
56
|
}
|
|
49
57
|
|
|
50
58
|
export const ShippingOptionDictionarySchema = Joi.object(
|
|
@@ -6,6 +6,7 @@ import { AccessibilityTypes } from './accessibility-types';
|
|
|
6
6
|
import { Signatory } from './signatory';
|
|
7
7
|
import { RegulationLevelTypes } from './dangerous-good/regulation-level-types';
|
|
8
8
|
import { TransportMeanTypes } from './dangerous-good/transport-mean-types';
|
|
9
|
+
import { CustomerExpectedDelivery } from './customer-expected-delivery/customer-expected-delivery';
|
|
9
10
|
|
|
10
11
|
/** @description Basic structure for shipping options */
|
|
11
12
|
export class AdvancedOptions {
|
|
@@ -35,7 +36,7 @@ export class AdvancedOptions {
|
|
|
35
36
|
dangerous_goods_contact?: DangerousGoodsContact;
|
|
36
37
|
/** @description Describes the transport of dangerous goods that is restricted to Limited Quantities of Dangerous Goods only */
|
|
37
38
|
limited_quantity?: boolean;
|
|
38
|
-
/** @description
|
|
39
|
+
/** @description Indicates whether the recipient should be notified of events related to the shipment. */
|
|
39
40
|
event_notification?: boolean;
|
|
40
41
|
/** @description Any other custom shipping options */
|
|
41
42
|
windsor_framework_details?: WindsorFrameworkDetails;
|
|
@@ -47,6 +48,20 @@ export class AdvancedOptions {
|
|
|
47
48
|
regulation_level?: RegulationLevelTypes;
|
|
48
49
|
/** @description Transportation means through which the dangerous goods are transported */
|
|
49
50
|
transport_mean?: TransportMeanTypes;
|
|
51
|
+
/** @description Indicates whether the carrier should unpack the goods after delivery. */
|
|
52
|
+
unpack?: boolean;
|
|
53
|
+
/** @description Specifies whether the carrier should remove and dispose of the packaging materials after unpacking. */
|
|
54
|
+
packaging_disposal?: boolean;
|
|
55
|
+
/** @description Determines whether assembly of the delivered product is required. */
|
|
56
|
+
assembly?: boolean;
|
|
57
|
+
/** @description Indicates whether disassembly of existing items is required prior to delivery or installation. */
|
|
58
|
+
disassembly?: boolean;
|
|
59
|
+
/** @description The date range when the customer expects the shipment to be delivered. ISO 8601 format */
|
|
60
|
+
customer_expected_delivery?: CustomerExpectedDelivery;
|
|
50
61
|
/** @description Indicates whether the recipient should be notified of events related to the shipment. */
|
|
62
|
+
delivery_as_addressed?: boolean;
|
|
63
|
+
/** @description Instructs the carrier to deliver the package only to the exact address provided. */
|
|
64
|
+
return_after_first_attempt?: boolean;
|
|
65
|
+
/** @description Ensures the shipment is immediately flagged for return to the sender if the initial delivery attempt fails. */
|
|
51
66
|
[key: string]: any;
|
|
52
67
|
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** @description This model represents the date range when the customer expects the shipment to be delivered. ISO 8601 format */
|
|
2
|
+
export class CustomerExpectedDelivery {
|
|
3
|
+
/** @description The beginning of the date range when the customer expects the shipment to be delivered. */
|
|
4
|
+
from_date?: string;
|
|
5
|
+
/** @description The end of the date range when the customer expects the shipment to be delivered. */
|
|
6
|
+
to_date?: string;
|
|
7
|
+
}
|