@shipengine/connect-carrier-api 4.21.0 → 4.22.1

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.
Files changed (31) hide show
  1. package/lib/app/metadata/shipping-option.d.ts +6 -0
  2. package/lib/app/metadata/shipping-option.js +6 -0
  3. package/lib/app/metadata/shipping-option.js.map +1 -1
  4. package/lib/models/advanced-options.d.ts +12 -1
  5. package/lib/models/advanced-options.js +11 -1
  6. package/lib/models/advanced-options.js.map +1 -1
  7. package/lib/models/customer-expected-delivery/customer-expected-delivery.d.ts +7 -0
  8. package/lib/models/customer-expected-delivery/customer-expected-delivery.js +12 -0
  9. package/lib/models/customer-expected-delivery/customer-expected-delivery.js.map +1 -0
  10. package/lib/models/dangerous-good/dangerous-goods-declaration.d.ts +6 -1
  11. package/lib/models/dangerous-good/dangerous-goods-declaration.js +4 -0
  12. package/lib/models/dangerous-good/dangerous-goods-declaration.js.map +1 -1
  13. package/lib/models/dangerous-good/dangerous-goods-package-info.d.ts +5 -2
  14. package/lib/models/dangerous-good/dangerous-goods-package-info.js +2 -0
  15. package/lib/models/dangerous-good/dangerous-goods-package-info.js.map +1 -1
  16. package/lib/models/dangerous-good/regulation-level-types.d.ts +11 -0
  17. package/lib/models/dangerous-good/regulation-level-types.js +13 -1
  18. package/lib/models/dangerous-good/regulation-level-types.js.map +1 -1
  19. package/lib/models/dangerous-good/regulation-set-types.d.ts +15 -0
  20. package/lib/models/dangerous-good/regulation-set-types.js +20 -0
  21. package/lib/models/dangerous-good/regulation-set-types.js.map +1 -0
  22. package/package.json +2 -2
  23. package/spec.json +75 -8
  24. package/src/app/metadata/shipping-option.ts +6 -0
  25. package/src/models/advanced-options.ts +12 -1
  26. package/src/models/customer-expected-delivery/customer-expected-delivery.ts +7 -0
  27. package/src/models/dangerous-good/dangerous-goods-declaration.ts +6 -1
  28. package/src/models/dangerous-good/dangerous-goods-package-info.ts +5 -2
  29. package/src/models/dangerous-good/regulation-level-types.ts +12 -0
  30. package/src/models/dangerous-good/regulation-set-types.ts +15 -0
  31. package/tsconfig.tsbuildinfo +1 -1
@@ -42,6 +42,12 @@ export declare enum ShippingOptionEnum {
42
42
  WindsorFrameworkMovementIndicator = "windsor-framework-movement-indicator",
43
43
  WindsorFrameworkNotAtRisk = "windsor-framework-not-at-risk",
44
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",
45
51
  DeliveryAsAddressed = "delivery-as-addressed",
46
52
  ReturnAfterFirstAttempt = "return-after-first-attempt"
47
53
  }
@@ -38,6 +38,12 @@ 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";
41
47
  ShippingOptionEnum["DeliveryAsAddressed"] = "delivery-as-addressed";
42
48
  ShippingOptionEnum["ReturnAfterFirstAttempt"] = "return-after-first-attempt";
43
49
  })(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,kBAgCX;AAhCD,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,mEAA6C,CAAA;IAC7C,4EAAsD,CAAA;AACxD,CAAC,EAhCW,kBAAkB,kCAAlB,kBAAkB,QAgC7B;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"}
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 Any other custom shipping options */
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,16 @@ 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. */
50
61
  delivery_as_addressed?: boolean;
51
62
  /** @description Instructs the carrier to deliver the package only to the exact address provided. */
@@ -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 Any other custom shipping options */
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,16 @@ 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;
44
54
  /** @description Indicates whether the recipient should be notified of events related to the shipment. */
45
55
  delivery_as_addressed;
46
56
  /** @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":";;;AASA,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,qDAAqD;IACrD,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,yGAAyG;IACzG,qBAAqB,CAAW;IAChC,oGAAoG;IACpG,0BAA0B,CAAW;CAGtC;AA7CD,0CA6CC"}
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"}
@@ -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?: string;
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":";;;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"}
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 { RegulationLevelTypes } from './regulation-level-types';
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?: RegulationLevelTypes;
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":";;;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"}
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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipengine/connect-carrier-api",
3
- "version": "4.21.0",
3
+ "version": "4.22.1",
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.2",
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.35.0"
6
+ "version": "1.36.0"
7
7
  },
8
8
  "paths": {
9
9
  "/Register": {
@@ -932,9 +932,27 @@
932
932
  "type": "boolean",
933
933
  "description": "Indicates whether document upload is enabled for the shipment."
934
934
  },
935
- "delivery_as_addressed": {
935
+ "unpack": {
936
+ "type": "boolean",
937
+ "description": "Indicates whether the carrier should unpack the goods after delivery."
938
+ },
939
+ "packaging_disposal": {
936
940
  "type": "boolean",
937
- "description": "Instructs the carrier to deliver the package only to the exact address provided."
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"
938
956
  },
939
957
  "return_after_first_attempt": {
940
958
  "type": "boolean",
@@ -1885,6 +1903,23 @@
1885
1903
  "additionalProperties": false,
1886
1904
  "description": "This model represents the charges related with customs."
1887
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
+ },
1888
1923
  "Customs": {
1889
1924
  "type": "object",
1890
1925
  "properties": {
@@ -2134,11 +2169,14 @@
2134
2169
  "DangerousGoodsDeclaration": {
2135
2170
  "type": "object",
2136
2171
  "properties": {
2137
- "regulation_set": {
2138
- "type": "string",
2139
- "description": "Name of the regulatory authority",
2172
+ "shipper_declaration": {
2173
+ "type": "boolean",
2174
+ "description": "Shipper declaration",
2140
2175
  "nullable": true
2141
2176
  },
2177
+ "regulation_set": {
2178
+ "$ref": "#/components/schemas/RegulationSetEnum"
2179
+ },
2142
2180
  "emergency_contact": {
2143
2181
  "$ref": "#/components/schemas/DangerousGoodsContact"
2144
2182
  },
@@ -2149,6 +2187,11 @@
2149
2187
  "type": "string",
2150
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.",
2151
2189
  "nullable": true
2190
+ },
2191
+ "contains_alcohol": {
2192
+ "type": "boolean",
2193
+ "description": "Indicates whether the shipment contains alcohol",
2194
+ "nullable": true
2152
2195
  }
2153
2196
  },
2154
2197
  "additionalProperties": false,
@@ -2205,7 +2248,10 @@
2205
2248
  "nullable": true
2206
2249
  },
2207
2250
  "regulation_level": {
2208
- "$ref": "#/components/schemas/RegulationLevelEnum"
2251
+ "$ref": "#/components/schemas/RegulationLevelEnumV2"
2252
+ },
2253
+ "dry_ice": {
2254
+ "$ref": "#/components/schemas/CarrierWeight"
2209
2255
  }
2210
2256
  },
2211
2257
  "additionalProperties": false,
@@ -3995,6 +4041,27 @@
3995
4041
  ],
3996
4042
  "type": "string"
3997
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
+ },
3998
4065
  "RelayPoint": {
3999
4066
  "required": [
4000
4067
  "opening_times",
@@ -6006,4 +6073,4 @@
6006
6073
  "description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
6007
6074
  }
6008
6075
  ]
6009
- }
6076
+ }
@@ -45,6 +45,12 @@ 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',
48
54
  DeliveryAsAddressed = 'delivery-as-addressed',
49
55
  ReturnAfterFirstAttempt = 'return-after-first-attempt',
50
56
  }
@@ -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 Any other custom shipping options */
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,16 @@ 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. */
51
62
  delivery_as_addressed?: boolean;
52
63
  /** @description Instructs the carrier to deliver the package only to the exact address provided. */
@@ -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
+ }
@@ -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?: string;
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 { RegulationLevelTypes } from './regulation-level-types';
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?: RegulationLevelTypes;
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
+ }