@shipengine/connect-carrier-api 4.6.9 → 4.7.0

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

@@ -22,5 +22,6 @@ exports.ShippedPackageSchema = joi_1.default.object({
     insured_value: currency_schema_1.CurrencySchema.required(),
     label_messages: label_message_schema_1.LabelMessageSchema.optional(),
     customs: customs_schema_1.CustomsSchema.optional(),
+    shipped_products: joi_1.default.array().items(identifier_schema_1.IdentifierSchema).optional(),
 });
 //# sourceMappingURL=shipped-package-schema.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"shipped-package-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-package-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,4DAAwD;AACxD,oCAA4C;AAC5C,wDAAoD;AACpD,gFAA2E;AAC3E,0EAAqE;AACrE,yEAAoE;AACpE,8DAA0D;AAE7C,QAAA,oBAAoB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC7C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,uBAAuB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,oCAAgB,CAAC,CAAC,QAAQ,EAAE;IACvE,iBAAiB,EAAE,iDAAsB,CAAC,QAAQ,EAAE;IACpD,cAAc,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC9C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,wBAAgB,CAAC,QAAQ,EAAE;IACvC,aAAa,EAAE,gCAAc,CAAC,QAAQ,EAAE;IACxC,cAAc,EAAE,yCAAkB,CAAC,QAAQ,EAAE;IAC7C,OAAO,EAAE,8BAAa,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC"}
+{"version":3,"file":"shipped-package-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-package-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,4DAAwD;AACxD,oCAA4C;AAC5C,wDAAoD;AACpD,gFAA2E;AAC3E,0EAAqE;AACrE,yEAAoE;AACpE,8DAA0D;AAE7C,QAAA,oBAAoB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC7C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,uBAAuB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,oCAAgB,CAAC,CAAC,QAAQ,EAAE;IACvE,iBAAiB,EAAE,iDAAsB,CAAC,QAAQ,EAAE;IACpD,cAAc,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC9C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,wBAAgB,CAAC,QAAQ,EAAE;IACvC,aAAa,EAAE,gCAAc,CAAC,QAAQ,EAAE;IACxC,cAAc,EAAE,yCAAkB,CAAC,QAAQ,EAAE;IAC7C,OAAO,EAAE,8BAAa,CAAC,QAAQ,EAAE;IACjC,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,oCAAgB,CAAC,CAAC,QAAQ,EAAE;CACjE,CAAC,CAAC"}

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

@@ -5,6 +5,7 @@ import { Dimensions } from '../units/dimensions';
 import { Currency } from '../currency';
 import { LabelMessage } from '../labels/label-message';
 import { Customs } from '../customs';
+import { ShippedProducts } from './shipped-products';
 /** @description Basic structure for a package that has been shipped */
 export declare class ShippedPackage {
     /** @description The carrier tracking number associated with this package */
@@ -29,4 +30,6 @@ export declare class ShippedPackage {
     label_messages?: LabelMessage;
     /** @description Basic structure for a customs declaration (Only available on international shipments) */
     customs?: Customs;
+    /** @description List of products associated with this package. */
+    shipped_products?: ShippedProducts[];
 }

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

@@ -25,6 +25,8 @@ class ShippedPackage {
     label_messages;
     /** @description Basic structure for a customs declaration (Only available on international shipments) */
     customs;
+    /** @description List of products associated with this package. */
+    shipped_products;
 }
 exports.ShippedPackage = ShippedPackage;
 //# sourceMappingURL=shipped-package.js.map

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":";;;AAQA,uEAAuE;AACvE,MAAa,cAAc;IACzB,4EAA4E;IAC5E,eAAe,CAAU;IACzB,yEAAyE;IACzE,YAAY,CAAU;IACtB,wEAAwE;IACxE,uBAAuB,CAAgB;IACvC,+DAA+D;IAC/D,iBAAiB,CAAoB;IACrC,2DAA2D;IAC3D,cAAc,CAAiB;IAC/B,6DAA6D;IAC7D,YAAY,CAAU;IACtB,0DAA0D;IAC1D,MAAM,CAAU;IAChB,6DAA6D;IAC7D,UAAU,CAAc;IACxB,sDAAsD;IACtD,aAAa,CAAY;IACzB,2EAA2E;IAC3E,cAAc,CAAgB;IAC9B,yGAAyG;IACzG,OAAO,CAAW;CACnB;AAvBD,wCAuBC"}
+{"version":3,"file":"shipped-package.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-package.ts"],"names":[],"mappings":";;;AASA,uEAAuE;AACvE,MAAa,cAAc;IACzB,4EAA4E;IAC5E,eAAe,CAAU;IACzB,yEAAyE;IACzE,YAAY,CAAU;IACtB,wEAAwE;IACxE,uBAAuB,CAAgB;IACvC,+DAA+D;IAC/D,iBAAiB,CAAoB;IACrC,2DAA2D;IAC3D,cAAc,CAAiB;IAC/B,6DAA6D;IAC7D,YAAY,CAAU;IACtB,0DAA0D;IAC1D,MAAM,CAAU;IAChB,6DAA6D;IAC7D,UAAU,CAAc;IACxB,sDAAsD;IACtD,aAAa,CAAY;IACzB,2EAA2E;IAC3E,cAAc,CAAgB;IAC9B,yGAAyG;IACzG,OAAO,CAAW;IAClB,kEAAkE;IAClE,gBAAgB,CAAqB;CACtC;AAzBD,wCAyBC"}

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

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

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShippedProductsSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const connect_carrier_api_1 = require("@shipengine/connect-carrier-api");
+const weight_details_schema_1 = require("../units/weight-details-schema");
+exports.ShippedProductsSchema = joi_1.default.object({
+    description: joi_1.default.string().optional(),
+    quantity: joi_1.default.number().optional(),
+    value: connect_carrier_api_1.CurrencySchema.optional(),
+    country_of_origin: joi_1.default.string().optional(),
+    harmonized_tariff_code: joi_1.default.string().optional(),
+    sku: joi_1.default.string().optional(),
+    sku_description: joi_1.default.string().optional(),
+    item_weight: weight_details_schema_1.WeightDetailsSchema.optional(),
+    product_url: joi_1.default.string().optional(),
+    vat_rate: joi_1.default.number().optional(),
+    mid_code: joi_1.default.string().optional(),
+    dangerous_goods: joi_1.default.object().optional(),
+});
+//# sourceMappingURL=shipped-products-schema.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,29 @@
+import { Currency, WeightDetails } from '@shipengine/connect-carrier-api';
+import { DangerousGoods } from '../dangerous-good/dangerous-goods';
+/** @description Basic structure for a product from a shipped shipment*/
+export declare class ShippedProducts {
+    /** @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;
+    /** @description The user specified count of items in this declaration. This value should be 1 or greater */
+    quantity?: number;
+    /** @description The user specified declared customs value of this customs item. Generally, this value needs to be greater than 0 to be accepted through customs */
+    value?: Currency;
+    /** @description The user specified declared country of origin of this customs item */
+    country_of_origin?: string;
+    /** @description The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information */
+    harmonized_tariff_code?: string;
+    /** @description The user specified SKU of this customs item. This field is completely free form. */
+    sku?: string;
+    /** @description The user specified SKU description of this customs item. This field is completely free form. */
+    sku_description?: string;
+    /** @description Detailed information about the weight of this item */
+    item_weight?: WeightDetails;
+    /** @description A link to the item being shipped on the seller's website, used by customs officials to visually compare the item in the package to the available photo on the website. */
+    product_url?: string;
+    /** @description The VAT rate applicable to the item being shipped, expressed as a decimal value between 0 and 1. */
+    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 List of dangerous goods model associated with this package passed to the carrier. */
+    dangerous_goods?: DangerousGoods[];
+}

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

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShippedProducts = void 0;
+/** @description Basic structure for a product from a shipped shipment*/
+class ShippedProducts {
+    /** @description A user specified free form string describing this customs item. If the field is absent the user has not specified a description */
+    description;
+    /** @description The user specified count of items in this declaration. This value should be 1 or greater */
+    quantity;
+    /** @description The user specified declared customs value of this customs item. Generally, this value needs to be greater than 0 to be accepted through customs */
+    value;
+    /** @description The user specified declared country of origin of this customs item */
+    country_of_origin;
+    /** @description The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information */
+    harmonized_tariff_code;
+    /** @description The user specified SKU of this customs item. This field is completely free form. */
+    sku;
+    /** @description The user specified SKU description of this customs item. This field is completely free form. */
+    sku_description;
+    /** @description Detailed information about the weight of this item */
+    item_weight;
+    /** @description A link to the item being shipped on the seller's website, used by customs officials to visually compare the item in the package to the available photo on the website. */
+    product_url;
+    /** @description The VAT rate applicable to the item being shipped, expressed as a decimal value between 0 and 1. */
+    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 List of dangerous goods model associated with this package passed to the carrier. */
+    dangerous_goods;
+}
+exports.ShippedProducts = ShippedProducts;
+//# sourceMappingURL=shipped-products.js.map

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

@@ -0,0 +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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.6.9",
+  "version": "4.7.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.20.1"
+    "version": "1.21.0"
   },
   "paths": {
     "/Register": {
@@ -716,7 +716,8 @@
           "commercial",
           "residential"
         ],
-        "type": "string"
+        "type": "string",
+        "description": "'Commercial' is no longer used, please use 'No'. <br />'Residential' is no longer used, please use 'Yes'."
       },
       "AddressWithContact": {
         "required": [
@@ -3964,11 +3965,105 @@
             },
             "description": "The insured value of this package.",
             "nullable": true
+          },
+          "products": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ShippedProducts"
+            },
+            "description": "List of products associated with this package.",
+            "nullable": true
           }
         },
         "additionalProperties": false,
         "description": "This is the model for a package that has had a label generated for it"
       },
+      "ShippedProducts": {
+        "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
+          },
+          "dangerous_goods": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/DangerousGoods"
+            },
+            "description": "List of dangerous Goods model associated with this package passed to the carrier.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "This model represents the product of a package that has had a label generated for it"
+      },
       "ShippedShipment": {
         "type": "object",
         "properties": {

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

@@ -19,4 +19,5 @@ export const ShippedPackageSchema = Joi.object({
   insured_value: CurrencySchema.required(),
   label_messages: LabelMessageSchema.optional(),
   customs: CustomsSchema.optional(),
+  shipped_products: Joi.array().items(IdentifierSchema).optional(),
 });

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

@@ -5,6 +5,7 @@ import { Dimensions } from '../units/dimensions';
 import { Currency } from '../currency';
 import { LabelMessage } from '../labels/label-message';
 import { Customs } from '../customs';
+import { ShippedProducts } from './shipped-products';
 
 /** @description Basic structure for a package that has been shipped */
 export class ShippedPackage {
@@ -30,4 +31,6 @@ export class ShippedPackage {
   label_messages?: LabelMessage;
   /** @description Basic structure for a customs declaration (Only available on international shipments) */
   customs?: Customs;
+  /** @description List of products associated with this package. */
+  shipped_products?: ShippedProducts[];
 }

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

@@ -0,0 +1,18 @@
+import Joi from 'joi';
+import { CurrencySchema } from '@shipengine/connect-carrier-api';
+import { WeightDetailsSchema } from '../units/weight-details-schema';
+
+export const ShippedProductsSchema = Joi.object({
+  description: Joi.string().optional(),
+  quantity: Joi.number().optional(),
+  value: CurrencySchema.optional(),
+  country_of_origin: Joi.string().optional(),
+  harmonized_tariff_code: Joi.string().optional(),
+  sku: Joi.string().optional(),
+  sku_description: Joi.string().optional(),
+  item_weight: WeightDetailsSchema.optional(),
+  product_url: Joi.string().optional(),
+  vat_rate: Joi.number().optional(),
+  mid_code: Joi.string().optional(),
+  dangerous_goods: Joi.object().optional(),
+});

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

@@ -0,0 +1,30 @@
+import { Currency, WeightDetails } from '@shipengine/connect-carrier-api';
+import { DangerousGoods } from '../dangerous-good/dangerous-goods';
+
+/** @description Basic structure for a product from a shipped shipment*/
+export class ShippedProducts {
+  /** @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;
+  /** @description The user specified count of items in this declaration. This value should be 1 or greater */
+  quantity?: number;
+  /** @description The user specified declared customs value of this customs item. Generally, this value needs to be greater than 0 to be accepted through customs */
+  value?: Currency;
+  /** @description The user specified declared country of origin of this customs item */
+  country_of_origin?: string;
+  /** @description The user specified Harmonized Tariff Code. See https://hts.usitc.gov/ for more information */
+  harmonized_tariff_code?: string;
+  /** @description The user specified SKU of this customs item. This field is completely free form. */
+  sku?: string;
+  /** @description The user specified SKU description of this customs item. This field is completely free form. */
+  sku_description?: string;
+  /** @description Detailed information about the weight of this item */
+  item_weight?: WeightDetails;
+  /** @description A link to the item being shipped on the seller's website, used by customs officials to visually compare the item in the package to the available photo on the website. */
+  product_url?: string;
+  /** @description The VAT rate applicable to the item being shipped, expressed as a decimal value between 0 and 1. */
+  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 List of dangerous goods model associated with this package passed to the carrier. */
+  dangerous_goods?: DangerousGoods[];
+}