@shipengine/connect-carrier-api 4.10.4 → 4.11.0

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

@@ -17,5 +17,8 @@ exports.CustomsItemSchema = joi_1.default.object({
     product_url: joi_1.default.string().optional(),
     vat_rate: joi_1.default.number().optional(),
     mid_code: joi_1.default.string().optional(),
+    return_reason: joi_1.default.string().optional(),
+    brand_name: joi_1.default.string().optional(),
+    size: joi_1.default.string().optional(),
 });
 //# sourceMappingURL=customs-item-schema.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"customs-item-schema.js","sourceRoot":"","sources":["../../../src/models/customs/customs-item-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wDAAoD;AACpD,0EAAqE;AAExD,QAAA,iBAAiB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC1C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,KAAK,EAAE,gCAAc,CAAC,QAAQ,EAAE;IAChC,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,sBAAsB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/C,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,WAAW,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC3C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC"}
+{"version":3,"file":"customs-item-schema.js","sourceRoot":"","sources":["../../../src/models/customs/customs-item-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wDAAoD;AACpD,0EAAqE;AAExD,QAAA,iBAAiB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC1C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,KAAK,EAAE,gCAAc,CAAC,QAAQ,EAAE;IAChC,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,sBAAsB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/C,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,WAAW,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC3C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAC"}

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

@@ -24,4 +24,10 @@ export declare class CustomsItem {
     vat_rate?: number;
     /** @description The Manufacturer Identification Code (MID). It is ussed as an alternative to the full name and address of a manufacturer, shipper or exporter and is always required for U.S. formal customs entries. */
     mid_code?: string;
+    /** @description Relevant for return shipments only. Description of the reason why the product is being returned. */
+    return_reason?: string;
+    /** @description Name of the product brand. */
+    brand_name?: string;
+    /** @description Size of the product (used only for clothes and shoes etc.). */
+    size?: string;
 }

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

@@ -25,6 +25,12 @@ class CustomsItem {
     vat_rate;
     /** @description The Manufacturer Identification Code (MID). It is ussed as an alternative to the full name and address of a manufacturer, shipper or exporter and is always required for U.S. formal customs entries. */
     mid_code;
+    /** @description Relevant for return shipments only. Description of the reason why the product is being returned. */
+    return_reason;
+    /** @description Name of the product brand. */
+    brand_name;
+    /** @description Size of the product (used only for clothes and shoes etc.). */
+    size;
 }
 exports.CustomsItem = CustomsItem;
 //# sourceMappingURL=customs-item.js.map

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,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"}
+{"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;IAClB,oHAAoH;IACpH,aAAa,CAAU;IACvB,8CAA8C;IAC9C,UAAU,CAAU;IACpB,+EAA+E;IAC/E,IAAI,CAAU;CACf;AA7BD,kCA6BC"}

package/lib/models/pickup/shipped-products-schema.js

@@ -18,5 +18,8 @@ exports.ShippedProductsSchema = joi_1.default.object({
     vat_rate: joi_1.default.number().optional(),
     mid_code: joi_1.default.string().optional(),
     dangerous_goods: joi_1.default.object().optional(),
+    return_reason: joi_1.default.string().optional(),
+    brand_name: joi_1.default.string().optional(),
+    size: joi_1.default.string().optional(),
 });
 //# sourceMappingURL=shipped-products-schema.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"shipped-products-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-products-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,yEAAiE;AACjE,0EAAqE;AAExD,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,KAAK,EAAE,oCAAc,CAAC,QAAQ,EAAE;IAChC,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,sBAAsB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/C,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,WAAW,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC3C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC"}
+{"version":3,"file":"shipped-products-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-products-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,yEAAiE;AACjE,0EAAqE;AAExD,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,KAAK,EAAE,oCAAc,CAAC,QAAQ,EAAE;IAChC,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,sBAAsB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/C,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,WAAW,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC3C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAC"}

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

@@ -26,4 +26,10 @@ export declare class ShippedProducts {
     mid_code?: string;
     /** @description List of dangerous goods model associated with this package passed to the carrier. */
     dangerous_goods?: DangerousGoods[];
+    /** @description Relevant for return shipments only. Description of the reason why the product is being returned. */
+    return_reason?: string;
+    /** @description Name of the product brand. */
+    brand_name?: string;
+    /** @description Size of the product (used only for clothes and shoes etc.). */
+    size?: string;
 }

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

@@ -27,6 +27,12 @@ class ShippedProducts {
     mid_code;
     /** @description List of dangerous goods model associated with this package passed to the carrier. */
     dangerous_goods;
+    /** @description Relevant for return shipments only. Description of the reason why the product is being returned. */
+    return_reason;
+    /** @description Name of the product brand. */
+    brand_name;
+    /** @description Size of the product (used only for clothes and shoes etc.). */
+    size;
 }
 exports.ShippedProducts = ShippedProducts;
 //# sourceMappingURL=shipped-products.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"shipped-products.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-products.ts"],"names":[],"mappings":";;;AAGA,wEAAwE;AACxE,MAAa,eAAe;IAC1B,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;IAClB,qGAAqG;IACrG,eAAe,CAAoB;CACpC;AAzBD,0CAyBC"}
+{"version":3,"file":"shipped-products.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-products.ts"],"names":[],"mappings":";;;AAGA,wEAAwE;AACxE,MAAa,eAAe;IAC1B,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;IAClB,qGAAqG;IACrG,eAAe,CAAoB;IACnC,oHAAoH;IACpH,aAAa,CAAU;IACvB,8CAA8C;IAC9C,UAAU,CAAU;IACpB,+EAA+E;IAC/E,IAAI,CAAU;CACf;AA/BD,0CA+BC"}

package/lib/models/products.d.ts

@@ -27,4 +27,10 @@ export declare class Products {
     mid_code?: string;
     /** @description List of dangerous goods model associated with this package passed to the carrier. */
     dangerous_goods?: DangerousGoods[];
+    /** @description Relevant for return shipments only. Description of the reason why the product is being returned. */
+    return_reason?: string;
+    /** @description Name of the product brand. */
+    brand_name?: string;
+    /** @description Size of the product (used only for clothes and shoes etc.). */
+    size?: string;
 }

package/lib/models/products.js

@@ -27,6 +27,12 @@ class Products {
     mid_code;
     /** @description List of dangerous goods model associated with this package passed to the carrier. */
     dangerous_goods;
+    /** @description Relevant for return shipments only. Description of the reason why the product is being returned. */
+    return_reason;
+    /** @description Name of the product brand. */
+    brand_name;
+    /** @description Size of the product (used only for clothes and shoes etc.). */
+    size;
 }
 exports.Products = Products;
 //# sourceMappingURL=products.js.map

package/lib/models/products.js.map

@@ -1 +1 @@
-{"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/models/products.ts"],"names":[],"mappings":";;;AAIA,iDAAiD;AACjD,MAAa,QAAQ;IACnB,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;IAClB,qGAAqG;IACrG,eAAe,CAAoB;CACpC;AAzBD,4BAyBC"}
+{"version":3,"file":"products.js","sourceRoot":"","sources":["../../src/models/products.ts"],"names":[],"mappings":";;;AAIA,iDAAiD;AACjD,MAAa,QAAQ;IACnB,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;IAClB,qGAAqG;IACrG,eAAe,CAAoB;IACnC,oHAAoH;IACpH,aAAa,CAAU;IACvB,8CAA8C;IAC9C,UAAU,CAAU;IACpB,+EAA+E;IAC/E,IAAI,CAAU;CACf;AA/BD,4BA+BC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.10.4",
+  "version": "4.11.0",
   "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.23.4"
+    "version": "1.24.1"
   },
   "paths": {
     "/Register": {
@@ -3310,6 +3310,21 @@
             },
             "description": "List of dangerous Goods model associated with this package passed to the carrier.",
             "nullable": true
+          },
+          "return_reason": {
+            "type": "string",
+            "description": "Relevant for return shipments only. Description of the reason why the product is being returned.",
+            "nullable": true
+          },
+          "brand": {
+            "type": "string",
+            "description": "Name of the product brand.",
+            "nullable": true
+          },
+          "size": {
+            "type": "string",
+            "description": "Size of the product (used only for clothes and shoes etc.).",
+            "nullable": true
           }
         },
         "additionalProperties": false,
@@ -4122,6 +4137,21 @@
             },
             "description": "List of dangerous Goods model associated with this package passed to the carrier.",
             "nullable": true
+          },
+          "return_reason": {
+            "type": "string",
+            "description": "Relevant for return shipments only. Description of the reason why the product is being returned.",
+            "nullable": true
+          },
+          "brand": {
+            "type": "string",
+            "description": "Name of the product brand.",
+            "nullable": true
+          },
+          "size": {
+            "type": "string",
+            "description": "Size of the product (used only for clothes and shoes etc.).",
+            "nullable": true
           }
         },
         "additionalProperties": false,

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

@@ -14,4 +14,7 @@ export const CustomsItemSchema = Joi.object({
   product_url: Joi.string().optional(),
   vat_rate: Joi.number().optional(),
   mid_code: Joi.string().optional(),
+  return_reason: Joi.string().optional(),
+  brand_name: Joi.string().optional(),
+  size: Joi.string().optional(),
 });

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

@@ -25,4 +25,10 @@ export class CustomsItem {
   vat_rate?: number;
   /** @description The Manufacturer Identification Code (MID). It is ussed as an alternative to the full name and address of a manufacturer, shipper or exporter and is always required for U.S. formal customs entries. */
   mid_code?: string;
+  /** @description Relevant for return shipments only. Description of the reason why the product is being returned. */
+  return_reason?: string;
+  /** @description Name of the product brand. */
+  brand_name?: string;
+  /** @description Size of the product (used only for clothes and shoes etc.). */
+  size?: string;
 }

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

@@ -15,4 +15,7 @@ export const ShippedProductsSchema = Joi.object({
   vat_rate: Joi.number().optional(),
   mid_code: Joi.string().optional(),
   dangerous_goods: Joi.object().optional(),
+  return_reason: Joi.string().optional(),
+  brand_name: Joi.string().optional(),
+  size: Joi.string().optional(),
 });

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

@@ -27,4 +27,10 @@ export class ShippedProducts {
   mid_code?: string;
   /** @description List of dangerous goods model associated with this package passed to the carrier. */
   dangerous_goods?: DangerousGoods[];
+  /** @description Relevant for return shipments only. Description of the reason why the product is being returned. */
+  return_reason?: string;
+  /** @description Name of the product brand. */
+  brand_name?: string;
+  /** @description Size of the product (used only for clothes and shoes etc.). */
+  size?: string;
 }

package/src/models/products.ts

@@ -28,4 +28,10 @@ export class Products {
   mid_code?: string;
   /** @description List of dangerous goods model associated with this package passed to the carrier. */
   dangerous_goods?: DangerousGoods[];
+  /** @description Relevant for return shipments only. Description of the reason why the product is being returned. */
+  return_reason?: string;
+  /** @description Name of the product brand. */
+  brand_name?: string;
+  /** @description Size of the product (used only for clothes and shoes etc.). */
+  size?: string;
 }