@shipengine/connect-carrier-api 4.8.13 → 4.9.1

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

@@ -1,6 +1,6 @@
 import { Currency } from '../currency';
 import { WeightDetails } from '../units';
-/** @description This model represents the customs declaration for a single item */
+/** @deprecated This object has been deprecated, please use packages.products[] instead */
 export declare class CustomsItem {
     /** @description A user specified free form string describing this customs item. If the field is absent the user has not specified a description */
     description?: string;

package/lib/models/customs/customs-item.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomsItem = void 0;
-/** @description This model represents the customs declaration for a single item */
+/** @deprecated This object has been deprecated, please use packages.products[] instead */
 class CustomsItem {
     /** @description A user specified free form string describing this customs item. If the field is absent the user has not specified a description */
     description;

package/lib/models/customs/customs-item.js.map

@@ -1 +1 @@
-{"version":3,"file":"customs-item.js","sourceRoot":"","sources":["../../../src/models/customs/customs-item.ts"],"names":[],"mappings":";;;AAGA,mFAAmF;AACnF,MAAa,WAAW;IACtB,mJAAmJ;IACnJ,WAAW,CAAU;IACrB,4GAA4G;IAC5G,QAAQ,CAAU;IAClB,mKAAmK;IACnK,KAAK,CAAY;IACjB,sFAAsF;IACtF,iBAAiB,CAAU;IAC3B,8GAA8G;IAC9G,sBAAsB,CAAU;IAChC,oGAAoG;IACpG,GAAG,CAAU;IACb,gHAAgH;IAChH,eAAe,CAAU;IACzB,sEAAsE;IACtE,WAAW,CAAiB;IAC5B,0LAA0L;IAC1L,WAAW,CAAU;IACrB,oHAAoH;IACpH,QAAQ,CAAU;IAClB,yNAAyN;IACzN,QAAQ,CAAU;CACnB;AAvBD,kCAuBC"}
+{"version":3,"file":"customs-item.js","sourceRoot":"","sources":["../../../src/models/customs/customs-item.ts"],"names":[],"mappings":";;;AAGA,0FAA0F;AAC1F,MAAa,WAAW;IACtB,mJAAmJ;IACnJ,WAAW,CAAU;IACrB,4GAA4G;IAC5G,QAAQ,CAAU;IAClB,mKAAmK;IACnK,KAAK,CAAY;IACjB,sFAAsF;IACtF,iBAAiB,CAAU;IAC3B,8GAA8G;IAC9G,sBAAsB,CAAU;IAChC,oGAAoG;IACpG,GAAG,CAAU;IACb,gHAAgH;IAChH,eAAe,CAAU;IACzB,sEAAsE;IACtE,WAAW,CAAiB;IAC5B,0LAA0L;IAC1L,WAAW,CAAU;IACrB,oHAAoH;IACpH,QAAQ,CAAU;IAClB,yNAAyN;IACzN,QAAQ,CAAU;CACnB;AAvBD,kCAuBC"}

package/lib/models/customs/customs-schema.js

@@ -13,7 +13,7 @@ const customs_charges_schema_1 = require("./customs-charges-schema");
 exports.CustomsSchema = joi_1.default.object({
     contents: customs_content_types_schema_1.CustomsContentTypesSchema.optional(),
     non_delivery: customs_non_delivery_schema_1.CustomsNonDeliverySchema.optional(),
-    customs_items: joi_1.default.array().items(customs_item_schema_1.CustomsItemSchema).required(),
+    customs_items: joi_1.default.array().items(customs_item_schema_1.CustomsItemSchema).optional(),
     buyer_shipping_amount_paid: currency_schema_1.CurrencySchema.optional(),
     duties_paid: currency_schema_1.CurrencySchema.optional(),
     declaration: joi_1.default.string().optional(),

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

@@ -11,7 +11,7 @@ export declare class Customs {
     contents?: CustomsContentTypes;
     /** @description Indicates what the seller would like done in case of an issue with delivery */
     non_delivery?: CustomsNonDelivery;
-    /** @description A list of customs items to declare */
+    /** @deprecated This object has been deprecated, please use packages.products[] instead */
     customs_items: CustomsItem[];
     /** @description Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper. */
     buyer_shipping_amount_paid?: Currency;

package/lib/models/customs/customs.js

@@ -7,7 +7,7 @@ class Customs {
     contents;
     /** @description Indicates what the seller would like done in case of an issue with delivery */
     non_delivery;
-    /** @description A list of customs items to declare */
+    /** @deprecated This object has been deprecated, please use packages.products[] instead */
     customs_items;
     /** @description Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper. */
     buyer_shipping_amount_paid;

package/lib/models/customs/customs.js.map

@@ -1 +1 @@
-{"version":3,"file":"customs.js","sourceRoot":"","sources":["../../../src/models/customs/customs.ts"],"names":[],"mappings":";;;AAQA,6DAA6D;AAC7D,MAAa,OAAO;IAClB,gFAAgF;IAChF,QAAQ,CAAuB;IAC/B,+FAA+F;IAC/F,YAAY,CAAsB;IAClC,sDAAsD;IACtD,aAAa,CAAiB;IAC9B,sJAAsJ;IACtJ,0BAA0B,CAAY;IACtC,iJAAiJ;IACjJ,WAAW,CAAY;IACvB,gFAAgF;IAChF,WAAW,CAAU;IACrB,iGAAiG;IACjG,mBAAmB,CAAoB;IACvC,oGAAoG;IACpG,kBAAkB,CAAoB;IACtC,oDAAoD;IACpD,0BAA0B,CAAkB;IAC5C,sDAAsD;IACtD,oBAAoB,CAAU;IAC9B,sNAAsN;IACtN,yBAAyB,CAAU;CACpC;AAvBD,0BAuBC"}
+{"version":3,"file":"customs.js","sourceRoot":"","sources":["../../../src/models/customs/customs.ts"],"names":[],"mappings":";;;AAQA,6DAA6D;AAC7D,MAAa,OAAO;IAClB,gFAAgF;IAChF,QAAQ,CAAuB;IAC/B,+FAA+F;IAC/F,YAAY,CAAsB;IAClC,0FAA0F;IAC1F,aAAa,CAAiB;IAC9B,sJAAsJ;IACtJ,0BAA0B,CAAY;IACtC,iJAAiJ;IACjJ,WAAW,CAAY;IACvB,gFAAgF;IAChF,WAAW,CAAU;IACrB,iGAAiG;IACjG,mBAAmB,CAAoB;IACvC,oGAAoG;IACpG,kBAAkB,CAAoB;IACtC,oDAAoD;IACpD,0BAA0B,CAAkB;IAC5C,sDAAsD;IACtD,oBAAoB,CAAU;IAC9B,sNAAsN;IACtN,yBAAyB,CAAU;CACpC;AAvBD,0BAuBC"}

package/lib/models/package.d.ts

@@ -18,7 +18,7 @@ export declare class 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) */
+    /** @deprecated For shipment-level information, the shipment `customs` object should be used, and for parcel-level items, the `packages.products` array should be used. */
     customs?: Customs;
     /** @description List of products goods model associated with this package passed to the carrier. */
     products?: Products[];

package/lib/models/package.js

@@ -15,7 +15,7 @@ class Package {
     insured_value;
     /** @description The message the seller requested to have on their label */
     label_messages;
-    /** @description Basic structure for a customs declaration (Only available on international shipments) */
+    /** @deprecated For shipment-level information, the shipment `customs` object should be used, and for parcel-level items, the `packages.products` array should be used. */
     customs;
     /** @description List of products goods model associated with this package passed to the carrier. */
     products;

package/lib/models/package.js.map

@@ -1 +1 @@
-{"version":3,"file":"package.js","sourceRoot":"","sources":["../../src/models/package.ts"],"names":[],"mappings":";;;AAOA,iDAAiD;AACjD,MAAa,OAAO;IAClB,uEAAuE;IACvE,YAAY,CAAU;IACtB,sIAAsI;IACtI,mBAAmB,CAAU;IAC7B,+DAA+D;IAC/D,iBAAiB,CAAoB;IACrC,2DAA2D;IAC3D,cAAc,CAAiB;IAC/B,sDAAsD;IACtD,aAAa,CAAY;IACzB,2EAA2E;IAC3E,cAAc,CAAgB;IAC9B,yGAAyG;IACzG,OAAO,CAAW;IAClB,oGAAoG;IACpG,QAAQ,CAAc;CACvB;AAjBD,0BAiBC"}
+{"version":3,"file":"package.js","sourceRoot":"","sources":["../../src/models/package.ts"],"names":[],"mappings":";;;AAOA,iDAAiD;AACjD,MAAa,OAAO;IAClB,uEAAuE;IACvE,YAAY,CAAU;IACtB,sIAAsI;IACtI,mBAAmB,CAAU;IAC7B,+DAA+D;IAC/D,iBAAiB,CAAoB;IACrC,2DAA2D;IAC3D,cAAc,CAAiB;IAC/B,sDAAsD;IACtD,aAAa,CAAY;IACzB,2EAA2E;IAC3E,cAAc,CAAgB;IAC9B,0KAA0K;IAC1K,OAAO,CAAW;IAClB,oGAAoG;IACpG,QAAQ,CAAc;CACvB;AAjBD,0BAiBC"}

package/lib/models/taxes/tax-identifier-type.d.ts

@@ -32,5 +32,7 @@ export declare enum TaxIdentifierType {
     /** @description Passport number*/
     PASSPORT = "passport",
     /** @description Australian Business Number*/
-    ABN = "abn"
+    ABN = "abn",
+    /** @description Windsor Framework Number*/
+    UKIMS = "ukims"
 }

package/lib/models/taxes/tax-identifier-type.js

@@ -37,5 +37,7 @@ var TaxIdentifierType;
     TaxIdentifierType["PASSPORT"] = "passport";
     /** @description Australian Business Number*/
     TaxIdentifierType["ABN"] = "abn";
+    /** @description Windsor Framework Number*/
+    TaxIdentifierType["UKIMS"] = "ukims";
 })(TaxIdentifierType || (exports.TaxIdentifierType = TaxIdentifierType = {}));
 //# sourceMappingURL=tax-identifier-type.js.map

package/lib/models/taxes/tax-identifier-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"tax-identifier-type.js","sourceRoot":"","sources":["../../../src/models/taxes/tax-identifier-type.ts"],"names":[],"mappings":";;;AAAA,qEAAqE;AACrE,IAAY,iBAkCX;AAlCD,WAAY,iBAAiB;IAC3B,8CAA8C;IAC9C,gCAAW,CAAA;IACX,mDAAmD;IACnD,gCAAW,CAAA;IACX,2CAA2C;IAC3C,gCAAW,CAAA;IACX,0DAA0D;IAC1D,gCAAW,CAAA;IACX,8EAA8E;IAC9E,kCAAa,CAAA;IACb;;;;;OAKG;IACH,kCAAa,CAAA;IACb;;OAEG;IACH,gCAAW,CAAA;IACX;;OAEG;IACH,kCAAa,CAAA;IACb,yDAAyD;IACzD,kCAAa,CAAA;IACb,uCAAuC;IACvC,gCAAW,CAAA;IACX,kCAAkC;IAClC,0CAAqB,CAAA;IACrB,6CAA6C;IAC7C,gCAAW,CAAA;AACb,CAAC,EAlCW,iBAAiB,iCAAjB,iBAAiB,QAkC5B"}
+{"version":3,"file":"tax-identifier-type.js","sourceRoot":"","sources":["../../../src/models/taxes/tax-identifier-type.ts"],"names":[],"mappings":";;;AAAA,qEAAqE;AACrE,IAAY,iBAoCX;AApCD,WAAY,iBAAiB;IAC3B,8CAA8C;IAC9C,gCAAW,CAAA;IACX,mDAAmD;IACnD,gCAAW,CAAA;IACX,2CAA2C;IAC3C,gCAAW,CAAA;IACX,0DAA0D;IAC1D,gCAAW,CAAA;IACX,8EAA8E;IAC9E,kCAAa,CAAA;IACb;;;;;OAKG;IACH,kCAAa,CAAA;IACb;;OAEG;IACH,gCAAW,CAAA;IACX;;OAEG;IACH,kCAAa,CAAA;IACb,yDAAyD;IACzD,kCAAa,CAAA;IACb,uCAAuC;IACvC,gCAAW,CAAA;IACX,kCAAkC;IAClC,0CAAqB,CAAA;IACrB,6CAA6C;IAC7C,gCAAW,CAAA;IACX,2CAA2C;IAC3C,oCAAe,CAAA;AACjB,CAAC,EApCW,iBAAiB,iCAAjB,iBAAiB,QAoC5B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.8.13",
+  "version": "4.9.1",
   "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.5"
+    "version": "1.23.0"
   },
   "paths": {
     "/Register": {
@@ -1732,9 +1732,6 @@
         "description": "This model represents the charges related with customs."
       },
       "Customs": {
-        "required": [
-          "customs_items"
-        ],
         "type": "object",
         "properties": {
           "contents": {
@@ -1743,14 +1740,6 @@
           "non_delivery": {
             "$ref": "#/components/schemas/CustomsNonDelivery"
           },
-          "customs_items": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/CustomsItem"
-            },
-            "description": "List of customs items to declare",
-            "nullable": true
-          },
           "buyer_shipping_amount_paid": {
             "required": [
               "currency",
@@ -1830,84 +1819,6 @@
         ],
         "type": "string"
       },
-      "CustomsItem": {
-        "required": [
-          "value"
-        ],
-        "type": "object",
-        "properties": {
-          "description": {
-            "type": "string",
-            "description": "A user specified free form string describing this customs item. If the field is absent the user has\r\nnot specified a description.",
-            "nullable": true
-          },
-          "quantity": {
-            "type": "integer",
-            "description": "The user specified count of items in this declaration. This value should be 1 or greater",
-            "format": "int32"
-          },
-          "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 user specified declared customs value of this customs item. Generally, this value needs to be greater\r\nthan 0 to be accepted through customs.",
-            "nullable": true
-          },
-          "country_of_origin": {
-            "type": "string",
-            "description": "The user specified declared country of origin of this customs item.",
-            "nullable": true
-          },
-          "harmonized_tariff_code": {
-            "type": "string",
-            "description": "The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information.",
-            "nullable": true
-          },
-          "sku": {
-            "type": "string",
-            "description": "The user specified SKU of this customs item. This field is completely free form.",
-            "nullable": true
-          },
-          "sku_description": {
-            "type": "string",
-            "description": "The user specified SKU description of this customs item. This field is completely free form.",
-            "nullable": true
-          },
-          "item_weight": {
-            "$ref": "#/components/schemas/WeightDetails"
-          },
-          "product_url": {
-            "type": "string",
-            "description": "A link to the item being shipped on the seller's website, used by customs officials\r\nto visually compare the item in the package to the available photo on the website.",
-            "nullable": true
-          },
-          "vat_rate": {
-            "type": "number",
-            "description": "The VAT rate applicable to the item being shipped, expressed as a decimal value between 0 and 1.",
-            "format": "double",
-            "nullable": true
-          },
-          "mid_code": {
-            "type": "string",
-            "description": "The Manufacturer Identification Code (MID). It is ussed as an alternative to the full\r\nname and address of a manufacturer, shipper or exporter and is always required for\r\nU.S. formal customs entries.",
-            "nullable": true
-          }
-        },
-        "additionalProperties": false,
-        "description": "This model represents the customs declaration for a single item."
-      },
       "CustomsNonDelivery": {
         "enum": [
           "return_to_sender",
@@ -3125,9 +3036,6 @@
           "label_messages": {
             "$ref": "#/components/schemas/LabelMessage"
           },
-          "customs": {
-            "$ref": "#/components/schemas/Customs"
-          },
           "products": {
             "type": "array",
             "items": {

package/src/models/customs/customs-item.ts

@@ -1,7 +1,7 @@
 import { Currency } from '../currency';
 import { WeightDetails } from '../units';
 
-/** @description This model represents the customs declaration for a single item */
+/** @deprecated This object has been deprecated, please use packages.products[] instead */
 export class CustomsItem {
   /** @description A user specified free form string describing this customs item. If the field is absent the user has not specified a description */
   description?: string;

package/src/models/customs/customs-schema.ts

@@ -10,7 +10,7 @@ import { CustomsChargesSchema } from './customs-charges-schema';
 export const CustomsSchema = Joi.object({
   contents: CustomsContentTypesSchema.optional(),
   non_delivery: CustomsNonDeliverySchema.optional(),
-  customs_items: Joi.array().items(CustomsItemSchema).required(),
+  customs_items: Joi.array().items(CustomsItemSchema).optional(),
   buyer_shipping_amount_paid: CurrencySchema.optional(),
   duties_paid: CurrencySchema.optional(),
   declaration: Joi.string().optional(),

package/src/models/customs/customs.ts

@@ -12,7 +12,7 @@ export class Customs {
   contents?: CustomsContentTypes;
   /** @description Indicates what the seller would like done in case of an issue with delivery */
   non_delivery?: CustomsNonDelivery;
-  /** @description A list of customs items to declare */
+  /** @deprecated This object has been deprecated, please use packages.products[] instead */
   customs_items!: CustomsItem[];
   /** @description Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper. */
   buyer_shipping_amount_paid?: Currency;

package/src/models/package.ts

@@ -19,7 +19,7 @@ export class 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) */
+  /** @deprecated For shipment-level information, the shipment `customs` object should be used, and for parcel-level items, the `packages.products` array should be used. */
   customs?: Customs;
   /** @description List of products goods model associated with this package passed to the carrier. */
   products?: Products[];

package/src/models/taxes/tax-identifier-type.ts

@@ -33,4 +33,6 @@ export enum TaxIdentifierType {
   PASSPORT = 'passport',
   /** @description Australian Business Number*/
   ABN = 'abn',
+  /** @description Windsor Framework Number*/
+  UKIMS = 'ukims',
 }