@shipengine/connect-carrier-api 4.8.6 → 4.8.8

package/lib/app/metadata/shipping-option.d.ts

@@ -38,6 +38,7 @@ export declare enum ShippingOptionEnum {
     SmsNotification = "sms-notification",
     SpecialHandling = "special-handling",
     ThirdPartyConsignee = "third-party-consignee",
-    CarrierInsurance = "carrier-insurance"
+    CarrierInsurance = "carrier-insurance",
+    WindsorFrameworkDetails = "windsor_framework_details"
 }
 export declare const ShippingOptionDictionarySchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/shipping-option.js

@@ -35,6 +35,7 @@ var ShippingOptionEnum;
     ShippingOptionEnum["SpecialHandling"] = "special-handling";
     ShippingOptionEnum["ThirdPartyConsignee"] = "third-party-consignee";
     ShippingOptionEnum["CarrierInsurance"] = "carrier-insurance";
+    ShippingOptionEnum["WindsorFrameworkDetails"] = "windsor_framework_details";
 })(ShippingOptionEnum || (exports.ShippingOptionEnum = ShippingOptionEnum = {}));
 exports.ShippingOptionDictionarySchema = joi_1.default.object(Object.values(ShippingOptionEnum).reduce((accumulator, option) => {
     accumulator[option] = exports.ShippingOptionDescriptionSchema;

package/lib/app/metadata/shipping-option.js.map

@@ -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,kBA2BX;AA3BD,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;AACxC,CAAC,EA3BW,kBAAkB,kCAAlB,kBAAkB,QA2B7B;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"}
+{"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,kBA4BX;AA5BD,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,2EAAqD,CAAA;AACvD,CAAC,EA5BW,kBAAkB,kCAAlB,kBAAkB,QA4B7B;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"}

package/lib/models/service-points/day-of-operation-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const DayOfOperationSchema: Joi.ObjectSchema<any>;

package/lib/models/service-points/day-of-operation-schema.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DayOfOperationSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+exports.DayOfOperationSchema = joi_1.default.object({
+    start: joi_1.default.string().optional().empty(),
+    end: joi_1.default.string().optional().empty(),
+});
+//# sourceMappingURL=day-of-operation-schema.js.map

package/lib/models/service-points/day-of-operation-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"day-of-operation-schema.js","sourceRoot":"","sources":["../../../src/models/service-points/day-of-operation-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAET,QAAA,oBAAoB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC7C,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtC,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACrC,CAAC,CAAC"}

package/lib/models/service-points/day-of-operation.d.ts

@@ -0,0 +1,7 @@
+/** @description Indicates a specific date window that a service point is open */
+export declare class DayOfOperation {
+    /** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
+    start?: string;
+    /** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
+    end?: string;
+}

package/lib/models/service-points/day-of-operation.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DayOfOperation = void 0;
+/** @description Indicates a specific date window that a service point is open */
+class DayOfOperation {
+    /** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
+    start;
+    /** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
+    end;
+}
+exports.DayOfOperation = DayOfOperation;
+//# sourceMappingURL=day-of-operation.js.map

package/lib/models/service-points/day-of-operation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"day-of-operation.js","sourceRoot":"","sources":["../../../src/models/service-points/day-of-operation.ts"],"names":[],"mappings":";;;AAAA,iFAAiF;AACjF,MAAa,cAAc;IACzB,uFAAuF;IACvF,KAAK,CAAU;IACf,qFAAqF;IACrF,GAAG,CAAU;CACd;AALD,wCAKC"}

package/lib/models/service-points/service-point.d.ts

@@ -2,6 +2,8 @@ import { ServicePointFeaturesEnum } from '../../app/metadata/service-point-featu
 import { ServicePointLocationTypeEnum } from '../../app/metadata/service-point-location-type';
 import { ServicePointResponseAddress } from './service-point-response-address';
 import { WeeklyHoursOfOperation } from './weekly-hours-of-operation';
+import { DayOfOperation } from './day-of-operation';
+import { SpecialOpeningTime } from './special-opening-time';
 /** @description Basic structure for a service point */
 export declare class ServicePoint {
     /** @description The identifier for the carrier's service point */
@@ -12,6 +14,10 @@ export declare class ServicePoint {
     hours_of_operation: WeeklyHoursOfOperation;
     /** @description Features supported by the service point */
     features?: ServicePointFeaturesEnum[];
+    /** @description Temporary closures days */
+    temporary_closures?: DayOfOperation[];
+    /** @description Special opening times */
+    special_opening_times?: SpecialOpeningTime[];
     /** @description Location type like PUDOs, parcelshops, postoffices, lockers, retailers own stores etc. */
     type?: ServicePointLocationTypeEnum;
 }

package/lib/models/service-points/service-point.js

@@ -11,6 +11,10 @@ class ServicePoint {
     hours_of_operation;
     /** @description Features supported by the service point */
     features;
+    /** @description Temporary closures days */
+    temporary_closures;
+    /** @description Special opening times */
+    special_opening_times;
     /** @description Location type like PUDOs, parcelshops, postoffices, lockers, retailers own stores etc. */
     type;
 }

package/lib/models/service-points/service-point.js.map

@@ -1 +1 @@
-{"version":3,"file":"service-point.js","sourceRoot":"","sources":["../../../src/models/service-points/service-point.ts"],"names":[],"mappings":";;;AAKA,uDAAuD;AACvD,MAAa,YAAY;IACvB,kEAAkE;IAClE,gBAAgB,CAAU;IAC1B,kEAAkE;IAClE,OAAO,CAA+B;IACtC,mEAAmE;IACnE,kBAAkB,CAA0B;IAC5C,2DAA2D;IAC3D,QAAQ,CAA8B;IACtC,0GAA0G;IAC1G,IAAI,CAAgC;CACrC;AAXD,oCAWC"}
+{"version":3,"file":"service-point.js","sourceRoot":"","sources":["../../../src/models/service-points/service-point.ts"],"names":[],"mappings":";;;AAOA,uDAAuD;AACvD,MAAa,YAAY;IACvB,kEAAkE;IAClE,gBAAgB,CAAU;IAC1B,kEAAkE;IAClE,OAAO,CAA+B;IACtC,mEAAmE;IACnE,kBAAkB,CAA0B;IAC5C,2DAA2D;IAC3D,QAAQ,CAA8B;IACtC,2CAA2C;IAC3C,kBAAkB,CAAoB;IACtC,yCAAyC;IACzC,qBAAqB,CAAwB;IAC7C,0GAA0G;IAC1G,IAAI,CAAgC;CACrC;AAfD,oCAeC"}

package/lib/models/service-points/special-opening-time-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const SpecialOpeningTimeSchema: Joi.ObjectSchema<any>;

package/lib/models/service-points/special-opening-time-schema.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpecialOpeningTimeSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const hours_of_operation_schema_1 = require("./hours-of-operation-schema");
+exports.SpecialOpeningTimeSchema = joi_1.default.object({
+    start: joi_1.default.string().optional().empty(),
+    end: joi_1.default.string().optional().empty(),
+    hours_of_operation: hours_of_operation_schema_1.HoursOfOperationSchema.optional(),
+});
+//# sourceMappingURL=special-opening-time-schema.js.map

package/lib/models/service-points/special-opening-time-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"special-opening-time-schema.js","sourceRoot":"","sources":["../../../src/models/service-points/special-opening-time-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,2EAAqE;AAExD,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtC,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACpC,kBAAkB,EAAE,kDAAsB,CAAC,QAAQ,EAAE;CACtD,CAAC,CAAC"}

package/lib/models/service-points/special-opening-time.d.ts

@@ -0,0 +1,10 @@
+import { HoursOfOperation } from './hours-of-operation';
+/** @description Indicates a specific date window that a service point is open with opening hours */
+export declare class SpecialOpeningTime {
+    /** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
+    start?: string;
+    /** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
+    end?: string;
+    /** @description The opening hours */
+    hours_of_operation?: HoursOfOperation[];
+}

package/lib/models/service-points/special-opening-time.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpecialOpeningTime = void 0;
+/** @description Indicates a specific date window that a service point is open with opening hours */
+class SpecialOpeningTime {
+    /** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
+    start;
+    /** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
+    end;
+    /** @description The opening hours */
+    hours_of_operation;
+}
+exports.SpecialOpeningTime = SpecialOpeningTime;
+//# sourceMappingURL=special-opening-time.js.map

package/lib/models/service-points/special-opening-time.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"special-opening-time.js","sourceRoot":"","sources":["../../../src/models/service-points/special-opening-time.ts"],"names":[],"mappings":";;;AAEA,oGAAoG;AACpG,MAAa,kBAAkB;IAC7B,uFAAuF;IACvF,KAAK,CAAU;IACf,qFAAqF;IACrF,GAAG,CAAU;IACb,qCAAqC;IACrC,kBAAkB,CAAsB;CACzC;AAPD,gDAOC"}

package/package.json

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

package/spec.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Shipping API",
     "description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
-    "version": "1.22.1"
+    "version": "1.22.3"
   },
   "paths": {
     "/Register": {
@@ -844,6 +844,9 @@
           "event_notification": {
             "type": "boolean",
             "description": "Indicates whether the recipient should be notified of events related to the shipment."
+          },
+          "windsor_framework_details": {
+            "$ref": "#/components/schemas/WindsorFrameworkDetails"
           }
         },
         "additionalProperties": { },
@@ -2041,6 +2044,24 @@
         "additionalProperties": false,
         "description": "This model represents contact information regarding dangerous goods"
       },
+      "DayOfOperation": {
+        "type": "object",
+        "properties": {
+          "start": {
+            "type": "string",
+            "description": "The start date expressed in ISO 8601 date only format",
+            "nullable": true,
+            "example": "2024-01-25"
+          },
+          "end": {
+            "type": "string",
+            "description": "The end date expressed in ISO 8601 date only format",
+            "nullable": true,
+            "example": "2024-01-27"
+          }
+        },
+        "additionalProperties": false
+      },
       "DimensionDetails": {
         "type": "object",
         "properties": {
@@ -2950,6 +2971,15 @@
         ],
         "type": "string"
       },
+      "MovementIndicator": {
+        "enum": [
+          "b2c",
+          "b2b",
+          "c2c",
+          "c2b"
+        ],
+        "type": "string"
+      },
       "NormalizeTrackingDataRequest": {
         "required": [
           "transaction_id"
@@ -3832,6 +3862,20 @@
             },
             "nullable": true
           },
+          "temporary_closures": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/DayOfOperation"
+            },
+            "nullable": true
+          },
+          "special_opening_times": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SpecialOpeningTime"
+            },
+            "nullable": true
+          },
           "type": {
             "$ref": "#/components/schemas/ServicePointLocationType"
           }
@@ -4198,6 +4242,32 @@
         "additionalProperties": false,
         "description": "This model represents a shipment that has already been shipped, and contains\r\nsummary information about the shipment."
       },
+      "SpecialOpeningTime": {
+        "type": "object",
+        "properties": {
+          "start": {
+            "type": "string",
+            "description": "The start date expressed in ISO 8601 date only format",
+            "nullable": true,
+            "example": "2024-01-25"
+          },
+          "end": {
+            "type": "string",
+            "description": "The end date expressed in ISO 8601 date only format",
+            "nullable": true,
+            "example": "2024-01-27"
+          },
+          "hours_of_operation": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/HoursOfOperation"
+            },
+            "description": "The opening hours",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
       "StandardizedStatusCodes": {
         "enum": [
           "UN",
@@ -4229,7 +4299,8 @@
           "nif",
           "inn",
           "cpf",
-          "cnpj"
+          "cnpj",
+          "ukims"
         ],
         "type": "string",
         "description": "Specifies the supported tax identification types."
@@ -4932,6 +5003,19 @@
         ],
         "type": "string",
         "description": "This model describes the possible units of weight."
+      },
+      "WindsorFrameworkDetails": {
+        "type": "object",
+        "properties": {
+          "movement_indicator": {
+            "$ref": "#/components/schemas/MovementIndicator"
+          },
+          "not_at_risk": {
+            "type": "boolean",
+            "description": "Indicates whether the shipment is at risk of entering EU territory or eligible for green lane due to zero duty rate for UK origin shipment."
+          }
+        },
+        "additionalProperties": false
       }
     }
   },
@@ -4981,4 +5065,4 @@
       "description": "Given inbound data, such as a webhook with tracking updates, return normalized information."
     }
   ]
-}
+}

package/src/app/metadata/shipping-option.ts

@@ -42,6 +42,7 @@ export enum ShippingOptionEnum {
   SpecialHandling = 'special-handling',
   ThirdPartyConsignee = 'third-party-consignee',
   CarrierInsurance = 'carrier-insurance',
+  WindsorFrameworkDetails = 'windsor_framework_details',
 }
 
 export const ShippingOptionDictionarySchema = Joi.object(

package/src/models/service-points/day-of-operation-schema.ts

@@ -0,0 +1,6 @@
+import Joi from 'joi';
+
+export const DayOfOperationSchema = Joi.object({
+  start: Joi.string().optional().empty(),
+  end: Joi.string().optional().empty(),
+});

package/src/models/service-points/day-of-operation.ts

@@ -0,0 +1,7 @@
+/** @description Indicates a specific date window that a service point is open */
+export class DayOfOperation {
+  /** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
+  start?: string;
+  /** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
+  end?: string;
+}

package/src/models/service-points/service-point.ts

@@ -2,6 +2,8 @@ import { ServicePointFeaturesEnum } from '../../app/metadata/service-point-featu
 import { ServicePointLocationTypeEnum } from '../../app/metadata/service-point-location-type';
 import { ServicePointResponseAddress } from './service-point-response-address';
 import { WeeklyHoursOfOperation } from './weekly-hours-of-operation';
+import { DayOfOperation } from './day-of-operation';
+import { SpecialOpeningTime } from './special-opening-time';
 
 /** @description Basic structure for a service point */
 export class ServicePoint {
@@ -13,6 +15,10 @@ export class ServicePoint {
   hours_of_operation!: WeeklyHoursOfOperation;
   /** @description Features supported by the service point */
   features?: ServicePointFeaturesEnum[];
+  /** @description Temporary closures days */
+  temporary_closures?: DayOfOperation[];
+  /** @description Special opening times */
+  special_opening_times?: SpecialOpeningTime[];
   /** @description Location type like PUDOs, parcelshops, postoffices, lockers, retailers own stores etc. */
   type?: ServicePointLocationTypeEnum;
 }

package/src/models/service-points/special-opening-time-schema.ts

@@ -0,0 +1,8 @@
+import Joi from 'joi';
+import { HoursOfOperationSchema } from './hours-of-operation-schema';
+
+export const SpecialOpeningTimeSchema = Joi.object({
+  start: Joi.string().optional().empty(),
+  end: Joi.string().optional().empty(),
+  hours_of_operation: HoursOfOperationSchema.optional(),
+});

package/src/models/service-points/special-opening-time.ts

@@ -0,0 +1,11 @@
+import { HoursOfOperation } from './hours-of-operation';
+
+/** @description Indicates a specific date window that a service point is open with opening hours */
+export class SpecialOpeningTime {
+  /** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
+  start?: string;
+  /** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
+  end?: string;
+  /** @description The opening hours */
+  hours_of_operation?: HoursOfOperation[];
+}