@shipengine/connect-carrier-api 2.12.12 → 2.12.14

package/README.md

@@ -2,6 +2,8 @@
 
 The purpose of this library is to fill a similar role that CarrierApi.Common serves for C# but for JavaScript & TypeScript. It will contain the models and definitions for Request/Response Bodies.
 
+Additionally, any changes made to carrier-api library spec, need to manually update the spec.json file. The CI action does not update this file for this repo.
+
 ## Building
 
 From the repository root, navigate to this package directory.

package/lib/app/metadata/service-point-location-type.d.ts

@@ -0,0 +1,6 @@
+import Joi from 'joi';
+export declare enum ServicePointLocationTypeEnum {
+    PUDO = "pudo",
+    Locker = "locker"
+}
+export declare const ServicePointLocationTypeEnumSchema: Joi.StringSchema;

package/lib/app/metadata/service-point-location-type.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServicePointLocationTypeEnumSchema = exports.ServicePointLocationTypeEnum = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+var ServicePointLocationTypeEnum;
+(function (ServicePointLocationTypeEnum) {
+    ServicePointLocationTypeEnum["PUDO"] = "pudo";
+    ServicePointLocationTypeEnum["Locker"] = "locker";
+})(ServicePointLocationTypeEnum = exports.ServicePointLocationTypeEnum || (exports.ServicePointLocationTypeEnum = {}));
+exports.ServicePointLocationTypeEnumSchema = joi_1.default.string().valid(...Object.values(ServicePointLocationTypeEnum));
+//# sourceMappingURL=service-point-location-type.js.map

package/lib/app/metadata/service-point-location-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-point-location-type.js","sourceRoot":"","sources":["../../../src/app/metadata/service-point-location-type.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,IAAY,4BAGX;AAHD,WAAY,4BAA4B;IACtC,6CAAa,CAAA;IACb,iDAAiB,CAAA;AACnB,CAAC,EAHW,4BAA4B,GAA5B,oCAA4B,KAA5B,oCAA4B,QAGvC;AAEY,QAAA,kCAAkC,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAClE,GAAG,MAAM,CAAC,MAAM,CAAC,4BAA4B,CAAC,CAC/C,CAAC"}

package/lib/models/customs/customs.d.ts

@@ -3,7 +3,7 @@ import { CustomsNonDelivery } from './customs-non-delivery';
 import { CustomsItem } from './customs-item';
 import { Currency } from '../currency';
 import { TermsOfTradeCode } from '../inconterms/terms-of-trade-code';
-import { ImporterOfRecords } from '../importer-records/ImporterOfRecords';
+import { ImporterOfRecord } from '../importer-records/importer_of_record';
 import { CustomsCharges } from './customs-charges';
 /** @description Basic structure for a customs declaration */
 export declare class Customs {
@@ -22,7 +22,7 @@ export declare class Customs {
     /** @description  Incoterms specify who is responsible for paying for and managing the shipment*/
     termsOfTradeCode?: TermsOfTradeCode;
     /** @description The owner or purchaser of the products being imported into a destination country.*/
-    importer_of_records?: ImporterOfRecords;
+    importer_of_record?: ImporterOfRecord;
     /** @description The charges related with customs.*/
     invoice_additional_details?: CustomsCharges;
     /**@description:   text explanation for the content */

package/lib/models/importer-records/{ImporterOfRecords.d.ts → importer_of_record.d.ts}

@@ -1,6 +1,9 @@
+import { TaxIdentifier } from '../taxes/tax-identifier';
 /** @description Basic structure for a Importer Records */
-export declare class ImporterOfRecords {
-    /** @description Indicates  Name of the owner or purchaser of the products being imported into a destination country */
+export declare class ImporterOfRecord {
+    /** @description Tax Ids associated with the party responsible for ensuring that imported goods comply with all customs and legal requirements of the country of import (importer of record) */
+    tax_identifiers?: TaxIdentifier[];
+    /** @description Indicates Name of the owner or purchaser of the products being imported into a destination country */
     name?: string;
     /** @description Indicates Company Name of the owner or purchaser of the products being imported into a destination country*/
     company_name?: string;
@@ -16,6 +19,8 @@ export declare class ImporterOfRecords {
     postal_code?: string;
     /** @description : Indicates country code of the owner or purchaser of the products being imported into a destination country*/
     country_code?: string;
-    /** @description : Indicates phone number  of the owner or purchaser of the products being imported into a destination country*/
+    /** @description : Indicates phone number of the owner or purchaser of the products being imported into a destination country*/
     phone?: string;
+    /** @description : Email associated with the party responsible for ensuring that imported goods comply with all customs and legal requirements of the country of import (importer of record)*/
+    email?: string;
 }

package/lib/models/importer-records/importer_of_record.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImporterOfRecord = void 0;
+/** @description Basic structure for a Importer Records */
+class ImporterOfRecord {
+}
+exports.ImporterOfRecord = ImporterOfRecord;
+//# sourceMappingURL=importer_of_record.js.map

package/lib/models/importer-records/importer_of_record.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"importer_of_record.js","sourceRoot":"","sources":["../../../src/models/importer-records/importer_of_record.ts"],"names":[],"mappings":";;;AAEA,0DAA0D;AAC1D,MAAa,gBAAgB;CAuB5B;AAvBD,4CAuBC"}

package/lib/models/pickup/shipped-package.d.ts

@@ -2,6 +2,9 @@ import { Identifier } from '../identifier';
 import { DimensionDetails } from '../units/dimension-details';
 import { WeightDetails } from '../units/weight-details';
 import { Dimensions } from '../units/dimensions';
+import { Currency } from '../currency';
+import { LabelMessage } from '../labels/label-message';
+import { Customs } from '../customs';
 /** @description Basic structure for a package that has been shipped */
 export declare class ShippedPackage {
     /** @description The carrier tracking number associated with this package */
@@ -18,4 +21,10 @@ export declare class ShippedPackage {
     weight?: number;
     /** @deprectated Please use the dimension_details property */
     dimensions?: Dimensions;
+    /** @description The insured value of this package. */
+    insured_value: Currency;
+    /** @description The message the seller requested to have on their label */
+    label_messages?: LabelMessage;
+    /** @description Basic structure for a customs declaration (Only available on international shipments) */
+    customs?: Customs;
 }

package/lib/models/pickup/shipped-package.js.map

@@ -1 +1 @@
-{"version":3,"file":"shipped-package.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-package.ts"],"names":[],"mappings":";;;AAKA,uEAAuE;AACvE,MAAa,cAAc;CAe1B;AAfD,wCAeC"}
+{"version":3,"file":"shipped-package.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-package.ts"],"names":[],"mappings":";;;AAQA,uEAAuE;AACvE,MAAa,cAAc;CAqB1B;AArBD,wCAqBC"}

package/lib/models/pickup/shipped-shipment.d.ts

@@ -3,6 +3,7 @@ import { ShipTo } from '../addresses/ship-to';
 import { AdvancedOptions } from '../advanced-options';
 import { Identifier } from '../identifier';
 import { ShippedPackage } from './shipped-package';
+import { PudoLocation } from '../../models';
 /** @description Basic structure for a shipment that has been shipped */
 export declare class ShippedShipment extends Label {
     /** @description The carrier tracking number associated with this package */
@@ -17,6 +18,8 @@ export declare class ShippedShipment extends Label {
     packages?: ShippedPackage[];
     /** @description Advanced shipping options (Contains Alcohol, Non Machinable, etc) */
     advanced_options?: AdvancedOptions;
+    /** @description Add pick-up location detail*/
+    pickup_location?: PudoLocation;
 }
 export declare class PickupShipment extends ShippedShipment {
 }

package/lib/models/pickup/shipped-shipment.js.map

@@ -1 +1 @@
-{"version":3,"file":"shipped-shipment.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-shipment.ts"],"names":[],"mappings":";;;AAAA,8CAA2C;AAM3C,wEAAwE;AACxE,MAAa,eAAgB,SAAQ,aAAK;CAazC;AAbD,0CAaC;AAED,MAAa,cAAe,SAAQ,eAAe;CAAG;AAAtD,wCAAsD"}
+{"version":3,"file":"shipped-shipment.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-shipment.ts"],"names":[],"mappings":";;;AAAA,8CAA2C;AAO3C,wEAAwE;AACxE,MAAa,eAAgB,SAAQ,aAAK;CAezC;AAfD,0CAeC;AAED,MAAa,cAAe,SAAQ,eAAe;CAAG;AAAtD,wCAAsD"}

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

@@ -4,6 +4,7 @@ exports.ServicePointSchema = void 0;
 const tslib_1 = require("tslib");
 const joi_1 = tslib_1.__importDefault(require("joi"));
 const service_point_feature_1 = require("../../app/metadata/service-point-feature");
+const service_point_location_type_1 = require("../../app/metadata/service-point-location-type");
 const service_point_response_address_schema_1 = require("./service-point-response-address-schema");
 const weekly_hours_of_operation_schema_1 = require("./weekly-hours-of-operation-schema");
 exports.ServicePointSchema = joi_1.default.object({
@@ -11,5 +12,6 @@ exports.ServicePointSchema = joi_1.default.object({
     address: service_point_response_address_schema_1.ServicePointResponseAddressSchema.required(),
     hours_of_operation: weekly_hours_of_operation_schema_1.WeeklyHoursOfOperationSchema.required(),
     features: joi_1.default.array().items(service_point_feature_1.ServicePointFeaturesEnumSchema).optional(),
+    type: service_point_location_type_1.ServicePointLocationTypeEnumSchema.optional(),
 });
 //# sourceMappingURL=service-point-schema.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"service-point-schema.js","sourceRoot":"","sources":["../../../src/models/service-points/service-point-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,oFAA0F;AAC1F,mGAA4F;AAC5F,yFAAkF;AAErE,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,OAAO,EAAE,yEAAiC,CAAC,QAAQ,EAAE;IACrD,kBAAkB,EAAE,+DAA4B,CAAC,QAAQ,EAAE;IAC3D,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,sDAA8B,CAAC,CAAC,QAAQ,EAAE;CACvE,CAAC,CAAC"}
+{"version":3,"file":"service-point-schema.js","sourceRoot":"","sources":["../../../src/models/service-points/service-point-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,oFAA0F;AAC1F,gGAAoG;AACpG,mGAA4F;AAC5F,yFAAkF;AAErE,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,OAAO,EAAE,yEAAiC,CAAC,QAAQ,EAAE;IACrD,kBAAkB,EAAE,+DAA4B,CAAC,QAAQ,EAAE;IAC3D,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,sDAA8B,CAAC,CAAC,QAAQ,EAAE;IACtE,IAAI,EAAE,gEAAkC,CAAC,QAAQ,EAAE;CACpD,CAAC,CAAC"}

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

@@ -1,4 +1,5 @@
 import { ServicePointFeaturesEnum } from '../../app/metadata/service-point-feature';
+import { ServicePointLocationTypeEnum } from '../../app/metadata/service-point-location-type';
 import { ServicePointResponseAddress } from './service-point-response-address';
 import { WeeklyHoursOfOperation } from './weekly-hours-of-operation';
 /** @description Basic structure for a service point */
@@ -11,4 +12,6 @@ export declare class ServicePoint {
     hours_of_operation: WeeklyHoursOfOperation;
     /** @description Features supported by the service point */
     features?: ServicePointFeaturesEnum[];
+    /** @description Location type like PUDOs, parcelshops, postoffices, lockers, retailers own stores etc. */
+    type?: ServicePointLocationTypeEnum;
 }

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":";;;AAIA,uDAAuD;AACvD,MAAa,YAAY;CASxB;AATD,oCASC"}
+{"version":3,"file":"service-point.js","sourceRoot":"","sources":["../../../src/models/service-points/service-point.ts"],"names":[],"mappings":";;;AAKA,uDAAuD;AACvD,MAAa,YAAY;CAWxB;AAXD,oCAWC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "2.12.12",
+  "version": "2.12.14",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://github.com/ShipEngine/connect",
   "main": "./lib/index.js",
@@ -37,14 +37,14 @@
     "vitest": "^0.23.4"
   },
   "optionalDependencies": {
-    "vm2": "^3.9.5"
+    "vm2": "^3.9.11"
   },
   "dependencies": {
     "joi": "^17.4.2",
     "tslib": "^2.5.0"
   },
   "peerDependencies": {
-    "@shipengine/connect-runtime": "^1.3.0",
+    "@shipengine/connect-runtime": "^1.3.1",
     "express": "^4.18.2",
     "winston": "^3.8.2"
   }

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.16.23"
+    "version": "1.16.24"
   },
   "paths": {
     "/Register": {
@@ -1604,8 +1604,8 @@
           "terms_of_trade_code": {
             "$ref": "#/components/schemas/TermsOfTradeCode"
           },
-          "importer_of_records": {
-            "$ref": "#/components/schemas/ImporterOfRecords"
+          "importer_of_record": {
+            "$ref": "#/components/schemas/ImporterOfRecord"
           },
           "invoice_additional_details": {
             "$ref": "#/components/schemas/CustomCharges"
@@ -2224,9 +2224,17 @@
         "additionalProperties": false,
         "description": "A key value pair, allowing custom properties to be stored."
       },
-      "ImporterOfRecords": {
+      "ImporterOfRecord": {
         "type": "object",
         "properties": {
+          "tax_identifiers": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TaxIdentifier"
+            },
+            "description": "Tax Ids associated with the party responsible for ensuring that imported goods comply with all customs and legal requirements of the country of import (importer of record)",
+            "nullable": true
+          },
           "name": {
             "type": "string",
             "description": "Indicates  Name of the owner or purchaser of the products being imported into a destination country",
@@ -2271,6 +2279,11 @@
             "type": "string",
             "description": "Indicates phone number  of the owner or purchaser of the products being imported into a destination country",
             "nullable": true
+          },
+          "email": {
+            "type": "string",
+            "description": "Email associated with the party responsible for ensuring that imported goods comply with all customs and legal requirements of the country of import (importer of record)",
+            "nullable": true
           }
         },
         "additionalProperties": false,
@@ -3179,6 +3192,10 @@
               "$ref": "#/components/schemas/ServicePointFeature"
             },
             "nullable": true
+          },
+          "type": {
+            "$ref": "#/components/schemas/ServicePointLocationType",
+            "nullable": true
           }
         },
         "additionalProperties": false
@@ -3211,6 +3228,13 @@
         ],
         "type": "string"
       },
+      "ServicePointLocationType": {
+        "enum": [
+          "pudo",
+          "locker"
+        ],
+        "type": "string"
+      },
       "ServicePointResponseAddress": {
         "required": [
           "postal_code",
@@ -3325,6 +3349,31 @@
             "type": "string",
             "description": "The code associated with the package type",
             "nullable": true
+          },
+          "label_messages": {
+            "$ref": "#/components/schemas/LabelMessage"
+          },
+          "insured_value": {
+            "required": [
+              "currency",
+              "amount"
+            ],
+            "type": "object",
+            "properties": {
+              "amount": {
+                "type": "string",
+                "description": "Decimal currency value, as a string."
+              },
+              "currency": {
+                "type": "string",
+                "description": "Alpha-3 currency code complying with ISO 4217."
+              }
+            },
+            "description": "The insured value of this package.",
+            "nullable": true
+          },
+          "customs": {
+            "$ref": "#/components/schemas/Customs"
           }
         },
         "additionalProperties": false,
@@ -3364,6 +3413,9 @@
           },
           "advanced_options": {
             "$ref": "#/components/schemas/AdvancedOptions"
+          },
+          "pickup_location": {
+            "$ref": "#/components/schemas/PudoLocation"
           }
         },
         "additionalProperties": false,

package/src/app/metadata/service-point-location-type.ts

@@ -0,0 +1,10 @@
+import Joi from 'joi';
+
+export enum ServicePointLocationTypeEnum {
+  PUDO = 'pudo',
+  Locker = 'locker',
+}
+
+export const ServicePointLocationTypeEnumSchema = Joi.string().valid(
+  ...Object.values(ServicePointLocationTypeEnum),
+);

package/src/models/customs/customs.ts

@@ -3,7 +3,7 @@ import { CustomsNonDelivery } from './customs-non-delivery';
 import { CustomsItem } from './customs-item';
 import { Currency } from '../currency';
 import { TermsOfTradeCode } from '../inconterms/terms-of-trade-code';
-import { ImporterOfRecords } from '../importer-records/ImporterOfRecords';
+import { ImporterOfRecord } from '../importer-records/importer_of_record';
 import { CustomsCharges } from './customs-charges';
 
 /** @description Basic structure for a customs declaration */
@@ -23,7 +23,7 @@ export class Customs {
   /** @description  Incoterms specify who is responsible for paying for and managing the shipment*/
   termsOfTradeCode?: TermsOfTradeCode;
   /** @description The owner or purchaser of the products being imported into a destination country.*/
-  importer_of_records?: ImporterOfRecords;
+  importer_of_record?: ImporterOfRecord;
   /** @description The charges related with customs.*/
   invoice_additional_details?: CustomsCharges;
   /**@description:   text explanation for the content */

package/src/models/importer-records/{ImporterOfRecords.ts → importer_of_record.ts}

@@ -1,6 +1,10 @@
+import { TaxIdentifier } from '../taxes/tax-identifier';
+
 /** @description Basic structure for a Importer Records */
-export class ImporterOfRecords {
-  /** @description Indicates  Name of the owner or purchaser of the products being imported into a destination country */
+export class ImporterOfRecord {
+  /** @description Tax Ids associated with the party responsible for ensuring that imported goods comply with all customs and legal requirements of the country of import (importer of record) */
+  tax_identifiers?: TaxIdentifier[];
+  /** @description Indicates Name of the owner or purchaser of the products being imported into a destination country */
   name?: string;
   /** @description Indicates Company Name of the owner or purchaser of the products being imported into a destination country*/
   company_name?: string;
@@ -16,6 +20,8 @@ export class ImporterOfRecords {
   postal_code?: string;
   /** @description : Indicates country code of the owner or purchaser of the products being imported into a destination country*/
   country_code?: string;
-  /** @description : Indicates phone number  of the owner or purchaser of the products being imported into a destination country*/
+  /** @description : Indicates phone number of the owner or purchaser of the products being imported into a destination country*/
   phone?: string;
+  /** @description : Email associated with the party responsible for ensuring that imported goods comply with all customs and legal requirements of the country of import (importer of record)*/
+  email?: string;
 }

package/src/models/pickup/shipped-package.ts

@@ -2,6 +2,9 @@ import { Identifier } from '../identifier';
 import { DimensionDetails } from '../units/dimension-details';
 import { WeightDetails } from '../units/weight-details';
 import { Dimensions } from '../units/dimensions';
+import { Currency } from '../currency';
+import { LabelMessage } from '../labels/label-message';
+import { Customs } from '../customs';
 
 /** @description Basic structure for a package that has been shipped */
 export class ShippedPackage {
@@ -19,4 +22,10 @@ export class ShippedPackage {
   weight?: number;
   /** @deprectated Please use the dimension_details property */
   dimensions?: Dimensions;
+  /** @description The insured value of this package. */
+  insured_value!: Currency;
+  /** @description The message the seller requested to have on their label */
+  label_messages?: LabelMessage;
+  /** @description Basic structure for a customs declaration (Only available on international shipments) */
+  customs?: Customs;
 }

package/src/models/pickup/shipped-shipment.ts

@@ -3,6 +3,7 @@ import { ShipTo } from '../addresses/ship-to';
 import { AdvancedOptions } from '../advanced-options';
 import { Identifier } from '../identifier';
 import { ShippedPackage } from './shipped-package';
+import { PudoLocation } from '../../models';
 
 /** @description Basic structure for a shipment that has been shipped */
 export class ShippedShipment extends Label {
@@ -18,6 +19,8 @@ export class ShippedShipment extends Label {
   packages?: ShippedPackage[];
   /** @description Advanced shipping options (Contains Alcohol, Non Machinable, etc) */
   advanced_options?: AdvancedOptions;
+  /** @description Add pick-up location detail*/
+  pickup_location?: PudoLocation;
 }
 
 export class PickupShipment extends ShippedShipment {}

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

@@ -1,5 +1,6 @@
 import Joi from 'joi';
 import { ServicePointFeaturesEnumSchema } from '../../app/metadata/service-point-feature';
+import { ServicePointLocationTypeEnumSchema } from '../../app/metadata/service-point-location-type';
 import { ServicePointResponseAddressSchema } from './service-point-response-address-schema';
 import { WeeklyHoursOfOperationSchema } from './weekly-hours-of-operation-schema';
 
@@ -8,4 +9,5 @@ export const ServicePointSchema = Joi.object({
   address: ServicePointResponseAddressSchema.required(),
   hours_of_operation: WeeklyHoursOfOperationSchema.required(),
   features: Joi.array().items(ServicePointFeaturesEnumSchema).optional(),
+  type: ServicePointLocationTypeEnumSchema.optional(),
 });

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

@@ -1,4 +1,5 @@
 import { ServicePointFeaturesEnum } from '../../app/metadata/service-point-feature';
+import { ServicePointLocationTypeEnum } from '../../app/metadata/service-point-location-type';
 import { ServicePointResponseAddress } from './service-point-response-address';
 import { WeeklyHoursOfOperation } from './weekly-hours-of-operation';
 
@@ -12,4 +13,6 @@ export class ServicePoint {
   hours_of_operation!: WeeklyHoursOfOperation;
   /** @description Features supported by the service point */
   features?: ServicePointFeaturesEnum[];
+  /** @description Location type like PUDOs, parcelshops, postoffices, lockers, retailers own stores etc. */
+  type?: ServicePointLocationTypeEnum;
 }