@shipengine/connect-carrier-api 4.16.0 → 4.16.2

package/lib/models/billing/billing-categories.d.ts

@@ -21,5 +21,17 @@ export declare enum BillingCategories {
     Returns = "returns",
     Notifications = "notifications",
     /** @description Amount to be paid to the driver, used for local delivery and courier services */
-    Tip = "tip"
+    Tip = "tip",
+    /** @description Duties and taxes charged for the shipment; used if DDP is chosen and the carrier supports passing back the estimated duties and taxes for the shipment. */
+    DutiesAndTaxes = "duties_and_taxes",
+    /** @description Fee for managing the import/export process, often separate from duties and taxes. */
+    BrokerageFee = "brokerage_fee",
+    /** @description Penalty for providing incorrect information when creating the shipment. For Adjustments use only. */
+    AdminFee = "admin_fee",
+    /** @description Carrier-assessed adjustment different from the original quote. For Adjustments use only. */
+    Adjustment = "adjustment",
+    /** @description Auctane service fee charged to the merchant for using the Auctane Fulfillment Logistics Wallet service. For Adjustments use only. */
+    AuctaneServiceFee = "auctane_service_fee",
+    /** @description Auctane Fulfillment Provider's price to charge the merchant for fulfilling the order. For Adjustments use only. */
+    ProductPrice = "product_price"
 }

package/lib/models/billing/billing-categories.js

@@ -26,5 +26,17 @@ var BillingCategories;
     BillingCategories["Notifications"] = "notifications";
     /** @description Amount to be paid to the driver, used for local delivery and courier services */
     BillingCategories["Tip"] = "tip";
+    /** @description Duties and taxes charged for the shipment; used if DDP is chosen and the carrier supports passing back the estimated duties and taxes for the shipment. */
+    BillingCategories["DutiesAndTaxes"] = "duties_and_taxes";
+    /** @description Fee for managing the import/export process, often separate from duties and taxes. */
+    BillingCategories["BrokerageFee"] = "brokerage_fee";
+    /** @description Penalty for providing incorrect information when creating the shipment. For Adjustments use only. */
+    BillingCategories["AdminFee"] = "admin_fee";
+    /** @description Carrier-assessed adjustment different from the original quote. For Adjustments use only. */
+    BillingCategories["Adjustment"] = "adjustment";
+    /** @description Auctane service fee charged to the merchant for using the Auctane Fulfillment Logistics Wallet service. For Adjustments use only. */
+    BillingCategories["AuctaneServiceFee"] = "auctane_service_fee";
+    /** @description Auctane Fulfillment Provider's price to charge the merchant for fulfilling the order. For Adjustments use only. */
+    BillingCategories["ProductPrice"] = "product_price";
 })(BillingCategories || (exports.BillingCategories = BillingCategories = {}));
 //# sourceMappingURL=billing-categories.js.map

package/lib/models/billing/billing-categories.js.map

@@ -1 +1 @@
-{"version":3,"file":"billing-categories.js","sourceRoot":"","sources":["../../../src/models/billing/billing-categories.ts"],"names":[],"mappings":";;;AAAA,oDAAoD;AACpD,IAAY,iBAuBX;AAvBD,WAAY,iBAAiB;IAC3B,oDAA+B,CAAA;IAC/B,0CAAqB,CAAA;IACrB,4CAAuB,CAAA;IACvB,oFAAoF;IACpF,wCAAmB,CAAA;IACnB,0CAAqB,CAAA;IACrB,+CAA0B,CAAA;IAC1B,uDAAkC,CAAA;IAClC,sCAAiB,CAAA;IACjB,gCAAW,CAAA;IACX,0CAAqB,CAAA;IACrB,0CAAqB,CAAA;IACrB,mDAA8B,CAAA;IAC9B,sCAAiB,CAAA;IACjB,wEAAwE;IACxE,iDAA4B,CAAA;IAC5B,iDAAiD;IACjD,0CAAqB,CAAA;IACrB,wCAAmB,CAAA;IACnB,oDAA+B,CAAA;IAC/B,iGAAiG;IACjG,gCAAW,CAAA;AACb,CAAC,EAvBW,iBAAiB,iCAAjB,iBAAiB,QAuB5B"}
+{"version":3,"file":"billing-categories.js","sourceRoot":"","sources":["../../../src/models/billing/billing-categories.ts"],"names":[],"mappings":";;;AAAA,oDAAoD;AACpD,IAAY,iBAmCX;AAnCD,WAAY,iBAAiB;IAC3B,oDAA+B,CAAA;IAC/B,0CAAqB,CAAA;IACrB,4CAAuB,CAAA;IACvB,oFAAoF;IACpF,wCAAmB,CAAA;IACnB,0CAAqB,CAAA;IACrB,+CAA0B,CAAA;IAC1B,uDAAkC,CAAA;IAClC,sCAAiB,CAAA;IACjB,gCAAW,CAAA;IACX,0CAAqB,CAAA;IACrB,0CAAqB,CAAA;IACrB,mDAA8B,CAAA;IAC9B,sCAAiB,CAAA;IACjB,wEAAwE;IACxE,iDAA4B,CAAA;IAC5B,iDAAiD;IACjD,0CAAqB,CAAA;IACrB,wCAAmB,CAAA;IACnB,oDAA+B,CAAA;IAC/B,iGAAiG;IACjG,gCAAW,CAAA;IACX,2KAA2K;IAC3K,wDAAmC,CAAA;IACnC,qGAAqG;IACrG,mDAA8B,CAAA;IAC9B,qHAAqH;IACrH,2CAAsB,CAAA;IACtB,4GAA4G;IAC5G,8CAAyB,CAAA;IACzB,qJAAqJ;IACrJ,8DAAyC,CAAA;IACzC,mIAAmI;IACnI,mDAA8B,CAAA;AAChC,CAAC,EAnCW,iBAAiB,iCAAjB,iBAAiB,QAmC5B"}

package/lib/models/rates/rate.d.ts

@@ -1,5 +1,6 @@
 import { BillingLineItem } from '../billing/billing-line-item';
 import { TimeWindow } from '../time-window';
+import { CarrierWeight } from '../units/carrier-weight';
 /** @description Basic structure for a rate */
 export declare class Rate {
     /** @description The service code uniquely identifies a shipping service that you offer. Which service codes can be passed to you will be configured in ShipEngine. If this field is missing, the rate will be discarded. */
@@ -32,4 +33,6 @@ export declare class Rate {
     zone?: string;
     /** @description Guaranteed delivery days. The number of days it will take for the package to be delivered */
     guaranteed_delivery_days?: number;
+    /** @description The actual weight value assessed by the carrier based on the ingredients provided, it may be used for customer billing purposes. */
+    carrier_weight?: CarrierWeight;
 }

package/lib/models/rates/rate.js

@@ -33,6 +33,8 @@ class Rate {
     zone;
     /** @description Guaranteed delivery days. The number of days it will take for the package to be delivered */
     guaranteed_delivery_days;
+    /** @description The actual weight value assessed by the carrier based on the ingredients provided, it may be used for customer billing purposes. */
+    carrier_weight;
 }
 exports.Rate = Rate;
 //# sourceMappingURL=rate.js.map

package/lib/models/rates/rate.js.map

@@ -1 +1 @@
-{"version":3,"file":"rate.js","sourceRoot":"","sources":["../../../src/models/rates/rate.ts"],"names":[],"mappings":";;;AAGA,8CAA8C;AAC9C,MAAa,IAAI;IACf,4NAA4N;IAC5N,YAAY,CAAU;IACtB,wDAAwD;IACxD,aAAa,CAAU;IACvB,8DAA8D;IAC9D,2BAA2B,CAAU;IACrC,qDAAqD;IACrD,kBAAkB,CAAqB;IACvC,iFAAiF;IACjF,cAAc,CAAY;IAC1B,mFAAmF;IACnF,gBAAgB,CAAY;IAC5B,+CAA+C;IAC/C,eAAe,CAAW;IAC1B,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0HAA0H;IAC1H,eAAe,CAAc;IAC7B,0DAA0D;IAC1D,eAAe,CAAU;IACzB,2JAA2J;IAC3J,mBAAmB,CAAU;IAC7B,yFAAyF;IACzF,uBAAuB,CAAU;IACjC,iDAAiD;IACjD,YAAY,CAAU;IACtB,6CAA6C;IAC7C,IAAI,CAAU;IACd,6GAA6G;IAC7G,wBAAwB,CAAU;CACnC;AA/BD,oBA+BC"}
+{"version":3,"file":"rate.js","sourceRoot":"","sources":["../../../src/models/rates/rate.ts"],"names":[],"mappings":";;;AAIA,8CAA8C;AAC9C,MAAa,IAAI;IACf,4NAA4N;IAC5N,YAAY,CAAU;IACtB,wDAAwD;IACxD,aAAa,CAAU;IACvB,8DAA8D;IAC9D,2BAA2B,CAAU;IACrC,qDAAqD;IACrD,kBAAkB,CAAqB;IACvC,iFAAiF;IACjF,cAAc,CAAY;IAC1B,mFAAmF;IACnF,gBAAgB,CAAY;IAC5B,+CAA+C;IAC/C,eAAe,CAAW;IAC1B,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0HAA0H;IAC1H,eAAe,CAAc;IAC7B,0DAA0D;IAC1D,eAAe,CAAU;IACzB,2JAA2J;IAC3J,mBAAmB,CAAU;IAC7B,yFAAyF;IACzF,uBAAuB,CAAU;IACjC,iDAAiD;IACjD,YAAY,CAAU;IACtB,6CAA6C;IAC7C,IAAI,CAAU;IACd,6GAA6G;IAC7G,wBAAwB,CAAU;IAClC,oJAAoJ;IACpJ,cAAc,CAAiB;CAChC;AAjCD,oBAiCC"}

package/lib/models/units/carrier-weight.d.ts

@@ -0,0 +1,8 @@
+import { WeightUnit } from './weight-unit';
+/** @description Represents the actual weight and unit supplied by a carrier based on the ingredients provided. */
+export declare class CarrierWeight {
+    /**  @description The actual weight value assessed by the carrier based on the ingredients provided, it may be used for customer billing purposes.  */
+    value?: number;
+    /** @description The unit of measurement for the carrier weight, it may be used for customer billing purposes. */
+    unit: WeightUnit;
+}

package/lib/models/units/carrier-weight.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CarrierWeight = void 0;
+/** @description Represents the actual weight and unit supplied by a carrier based on the ingredients provided. */
+class CarrierWeight {
+    /**  @description The actual weight value assessed by the carrier based on the ingredients provided, it may be used for customer billing purposes.  */
+    value;
+    /** @description The unit of measurement for the carrier weight, it may be used for customer billing purposes. */
+    unit;
+}
+exports.CarrierWeight = CarrierWeight;
+//# sourceMappingURL=carrier-weight.js.map

package/lib/models/units/carrier-weight.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"carrier-weight.js","sourceRoot":"","sources":["../../../src/models/units/carrier-weight.ts"],"names":[],"mappings":";;;AAEA,kHAAkH;AAClH,MAAa,aAAa;IACxB,sJAAsJ;IACtJ,KAAK,CAAU;IACf,iHAAiH;IACjH,IAAI,CAAc;CACnB;AALD,sCAKC"}

package/lib/responses/create-label-response.d.ts

@@ -1,5 +1,6 @@
 import { BaseResponse } from './base-response';
 import { LabelDownload, FormDownload, Document, BillingLineItem, LabelPackage, Identifier, TimeWindow, RelayPointDetails, PaperlessDetails, PudoLocation } from '../models';
+import { CarrierWeight } from '../models/units/carrier-weight';
 /** @description Basic structure for a response to create a label */
 export declare class CreateLabelResponse extends BaseResponse {
     transaction_id: string;
@@ -22,4 +23,5 @@ export declare class CreateLabelResponse extends BaseResponse {
     relay_points?: RelayPointDetails;
     dropoff_location?: PudoLocation;
     pickup_location?: PudoLocation;
+    carrier_weight?: CarrierWeight;
 }

package/lib/responses/create-label-response.js

@@ -24,6 +24,7 @@ class CreateLabelResponse extends base_response_1.BaseResponse {
     relay_points;
     dropoff_location;
     pickup_location;
+    carrier_weight;
 }
 exports.CreateLabelResponse = CreateLabelResponse;
 //# sourceMappingURL=create-label-response.js.map

package/lib/responses/create-label-response.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-label-response.js","sourceRoot":"","sources":["../../src/responses/create-label-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAc/C,oEAAoE;AACpE,MAAa,mBAAoB,SAAQ,4BAAY;IACnD,cAAc,CAAU;IACxB,cAAc,CAAiB;IAC/B,aAAa,CAAgB;IAC7B,iBAAiB,CAAoB;IACrC,SAAS,CAAc;IACvB,QAAQ,CAAkB;IAC1B,kBAAkB,CAAqB;IACvC,eAAe,CAAU;IACzB,YAAY,CAAU;IACtB,SAAS,CAAW;IACpB,uBAAuB,CAAgB;IACvC,2BAA2B,CAAU;IACrC,yBAAyB,CAAU;IACnC,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0HAA0H;IAC1H,eAAe,CAAc;IAC7B,YAAY,CAAqB;IACjC,gBAAgB,CAAgB;IAChC,eAAe,CAAgB;CAChC;AArBD,kDAqBC"}
+{"version":3,"file":"create-label-response.js","sourceRoot":"","sources":["../../src/responses/create-label-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAe/C,oEAAoE;AACpE,MAAa,mBAAoB,SAAQ,4BAAY;IACnD,cAAc,CAAU;IACxB,cAAc,CAAiB;IAC/B,aAAa,CAAgB;IAC7B,iBAAiB,CAAoB;IACrC,SAAS,CAAc;IACvB,QAAQ,CAAkB;IAC1B,kBAAkB,CAAqB;IACvC,eAAe,CAAU;IACzB,YAAY,CAAU;IACtB,SAAS,CAAW;IACpB,uBAAuB,CAAgB;IACvC,2BAA2B,CAAU;IACrC,yBAAyB,CAAU;IACnC,wIAAwI;IACxI,qBAAqB,CAAc;IACnC,0HAA0H;IAC1H,eAAe,CAAc;IAC7B,YAAY,CAAqB;IACjC,gBAAgB,CAAgB;IAChC,eAAe,CAAgB;IAC/B,cAAc,CAAiB;CAChC;AAtBD,kDAsBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.16.0",
+  "version": "4.16.2",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",
@@ -44,7 +44,7 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@shipengine/connect-runtime": "^4.10.0",
+    "@shipengine/connect-runtime": "^4.10.1",
     "express": "^4.18.2",
     "winston": "^3.8.2"
   }

package/spec.json

@@ -1218,6 +1218,20 @@
         "type": "string",
         "description": "An enumeration of common reasons cancellations occur"
       },
+      "CarrierWeight": {
+        "type": "object",
+        "properties": {
+          "value": {
+            "type": "number",
+            "description": "The actual weight value assessed by the carrier based on the ingredients provided, it may be used for customer billing purposes.",
+            "format": "double"
+          },
+          "unit": {
+            "$ref": "#/components/schemas/WeightUnit"
+          }
+        },
+        "additionalProperties": false
+      },
       "CodPaymentType": {
         "enum": [
           "any",
@@ -1489,6 +1503,9 @@
           },
           "paperless_details": {
             "$ref": "#/components/schemas/PaperlessDetails"
+          },
+          "carrier_weight": {
+            "$ref": "#/components/schemas/CarrierWeight"
           }
         },
         "additionalProperties": false,
@@ -3528,6 +3545,9 @@
             "type": "integer",
             "format": "int32",
             "nullable": true
+          },
+          "carrier_weight": {
+            "$ref": "#/components/schemas/CarrierWeight"
           }
         },
         "additionalProperties": false,

package/src/models/billing/billing-categories.ts

@@ -22,4 +22,16 @@ export enum BillingCategories {
   Notifications = 'notifications',
   /** @description Amount to be paid to the driver, used for local delivery and courier services */
   Tip = 'tip',
+  /** @description Duties and taxes charged for the shipment; used if DDP is chosen and the carrier supports passing back the estimated duties and taxes for the shipment. */
+  DutiesAndTaxes = 'duties_and_taxes',
+  /** @description Fee for managing the import/export process, often separate from duties and taxes. */
+  BrokerageFee = 'brokerage_fee',
+  /** @description Penalty for providing incorrect information when creating the shipment. For Adjustments use only. */
+  AdminFee = 'admin_fee',
+  /** @description Carrier-assessed adjustment different from the original quote. For Adjustments use only. */
+  Adjustment = 'adjustment',
+  /** @description Auctane service fee charged to the merchant for using the Auctane Fulfillment Logistics Wallet service. For Adjustments use only. */
+  AuctaneServiceFee = 'auctane_service_fee',
+  /** @description Auctane Fulfillment Provider's price to charge the merchant for fulfilling the order. For Adjustments use only. */
+  ProductPrice = 'product_price',
 }

package/src/models/rates/rate.ts

@@ -1,5 +1,6 @@
 import { BillingLineItem } from '../billing/billing-line-item';
 import { TimeWindow } from '../time-window';
+import { CarrierWeight } from '../units/carrier-weight';
 
 /** @description Basic structure for a rate */
 export class Rate {
@@ -33,4 +34,6 @@ export class Rate {
   zone?: string;
   /** @description Guaranteed delivery days. The number of days it will take for the package to be delivered */
   guaranteed_delivery_days?: number;
+  /** @description The actual weight value assessed by the carrier based on the ingredients provided, it may be used for customer billing purposes. */
+  carrier_weight?: CarrierWeight;
 }

package/src/models/units/carrier-weight.ts

@@ -0,0 +1,9 @@
+import { WeightUnit } from './weight-unit';
+
+/** @description Represents the actual weight and unit supplied by a carrier based on the ingredients provided. */
+export class CarrierWeight {
+  /**  @description The actual weight value assessed by the carrier based on the ingredients provided, it may be used for customer billing purposes.  */
+  value?: number;
+  /** @description The unit of measurement for the carrier weight, it may be used for customer billing purposes. */
+  unit!: WeightUnit;
+}

package/src/responses/create-label-response.ts

@@ -11,6 +11,7 @@ import {
   PaperlessDetails,
   PudoLocation,
 } from '../models';
+import { CarrierWeight } from '../models/units/carrier-weight';
 
 /** @description Basic structure for a response to create a label */
 export class CreateLabelResponse extends BaseResponse {
@@ -34,4 +35,5 @@ export class CreateLabelResponse extends BaseResponse {
   relay_points?: RelayPointDetails;
   dropoff_location?: PudoLocation;
   pickup_location?: PudoLocation;
+  carrier_weight?: CarrierWeight;
 }