@shipengine/connect-carrier-api 4.16.1 → 4.16.3

package/lib/app/metadata/carrier-attributes.d.ts

@@ -1,11 +1,22 @@
 import Joi from 'joi';
 export declare enum CarrierAttributeEnum {
+    /** @description Manifesting is done electronically. */
     ManifestDigital = "ManifestDigital",
+    /** @description Manifesting is done via print forms. */
     ManifestPhysical = "ManifestPhysical",
+    /** @description The shipping provider is a shipping consolidator. */
     Consolidator = "Consolidator",
+    /** @description The shipping provider is a regional carrier. */
     Regional = "Regional",
+    /** @description The shipping provider requires a inbound webhook id. */
     RequiresInboundWebhook = "RequiresInboundWebhook",
+    /** @description The shipping provider is capable of returning rate for all services. */
+    NonZeroRating = "NonZeroRating",
+    /** @description The shipping provider can receive tracking updates via inbound webhooks or file based tracking for all services */
+    InboundTrackingUpdates = "InboundTrackingUpdates",
+    /** @description The shipping provider returns status details via tracking */
     DetailedStatuses = "DetailedStatuses",
+    /** @description The shipping provider returns an image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient via tracking */
     ProofOfDelivery = "ProofOfDelivery"
 }
 export declare const CarrierAttributeEnumSchema: Joi.StringSchema;

package/lib/app/metadata/carrier-attributes.js

@@ -5,12 +5,23 @@ const tslib_1 = require("tslib");
 const joi_1 = tslib_1.__importDefault(require("joi"));
 var CarrierAttributeEnum;
 (function (CarrierAttributeEnum) {
+    /** @description Manifesting is done electronically. */
     CarrierAttributeEnum["ManifestDigital"] = "ManifestDigital";
+    /** @description Manifesting is done via print forms. */
     CarrierAttributeEnum["ManifestPhysical"] = "ManifestPhysical";
+    /** @description The shipping provider is a shipping consolidator. */
     CarrierAttributeEnum["Consolidator"] = "Consolidator";
+    /** @description The shipping provider is a regional carrier. */
     CarrierAttributeEnum["Regional"] = "Regional";
+    /** @description The shipping provider requires a inbound webhook id. */
     CarrierAttributeEnum["RequiresInboundWebhook"] = "RequiresInboundWebhook";
+    /** @description The shipping provider is capable of returning rate for all services. */
+    CarrierAttributeEnum["NonZeroRating"] = "NonZeroRating";
+    /** @description The shipping provider can receive tracking updates via inbound webhooks or file based tracking for all services */
+    CarrierAttributeEnum["InboundTrackingUpdates"] = "InboundTrackingUpdates";
+    /** @description The shipping provider returns status details via tracking */
     CarrierAttributeEnum["DetailedStatuses"] = "DetailedStatuses";
+    /** @description The shipping provider returns an image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient via tracking */
     CarrierAttributeEnum["ProofOfDelivery"] = "ProofOfDelivery";
 })(CarrierAttributeEnum || (exports.CarrierAttributeEnum = CarrierAttributeEnum = {}));
 exports.CarrierAttributeEnumSchema = joi_1.default.string().valid(...Object.values(CarrierAttributeEnum));

package/lib/app/metadata/carrier-attributes.js.map

@@ -1 +1 @@
-{"version":3,"file":"carrier-attributes.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier-attributes.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,IAAY,oBAQX;AARD,WAAY,oBAAoB;IAC9B,2DAAmC,CAAA;IACnC,6DAAqC,CAAA;IACrC,qDAA6B,CAAA;IAC7B,6CAAqB,CAAA;IACrB,yEAAiD,CAAA;IACjD,6DAAqC,CAAA;IACrC,2DAAmC,CAAA;AACrC,CAAC,EARW,oBAAoB,oCAApB,oBAAoB,QAQ/B;AAEY,QAAA,0BAA0B,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAC1D,GAAG,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CACvC,CAAC"}
+{"version":3,"file":"carrier-attributes.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier-attributes.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,IAAY,oBAmBX;AAnBD,WAAY,oBAAoB;IAC9B,uDAAuD;IACvD,2DAAmC,CAAA;IACnC,wDAAwD;IACxD,6DAAqC,CAAA;IACrC,qEAAqE;IACrE,qDAA6B,CAAA;IAC7B,gEAAgE;IAChE,6CAAqB,CAAA;IACrB,wEAAwE;IACxE,yEAAiD,CAAA;IACjD,wFAAwF;IACxF,uDAA+B,CAAA;IAC/B,mIAAmI;IACnI,yEAAiD,CAAA;IACjD,6EAA6E;IAC7E,6DAAqC,CAAA;IACrC,2LAA2L;IAC3L,2DAAmC,CAAA;AACrC,CAAC,EAnBW,oBAAoB,oCAApB,oBAAoB,QAmB/B;AAEY,QAAA,0BAA0B,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAC1D,GAAG,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CACvC,CAAC"}

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.1",
+  "version": "4.16.3",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",

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/app/metadata/carrier-attributes.ts

@@ -1,12 +1,23 @@
 import Joi from 'joi';
 
 export enum CarrierAttributeEnum {
+  /** @description Manifesting is done electronically. */
   ManifestDigital = 'ManifestDigital',
+  /** @description Manifesting is done via print forms. */
   ManifestPhysical = 'ManifestPhysical',
+  /** @description The shipping provider is a shipping consolidator. */
   Consolidator = 'Consolidator',
+  /** @description The shipping provider is a regional carrier. */
   Regional = 'Regional',
+  /** @description The shipping provider requires a inbound webhook id. */
   RequiresInboundWebhook = 'RequiresInboundWebhook',
+  /** @description The shipping provider is capable of returning rate for all services. */
+  NonZeroRating = 'NonZeroRating',
+  /** @description The shipping provider can receive tracking updates via inbound webhooks or file based tracking for all services */
+  InboundTrackingUpdates = 'InboundTrackingUpdates',
+  /** @description The shipping provider returns status details via tracking */
   DetailedStatuses = 'DetailedStatuses',
+  /** @description The shipping provider returns an image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient via tracking */
   ProofOfDelivery = 'ProofOfDelivery',
 }
 

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;
 }