@shipengine/connect-carrier-api 2.2.2 → 2.2.3

package/lib/models/tracking/tracking-info.d.ts

@@ -5,23 +5,41 @@ import { TrackEvent } from './track-event';
 import Joi from 'joi';
 /** @description Basic structure for tracking information */
 export declare class TrackingInfo {
+    /** @description The human readable name of the carrier tracking this shipment. */
     carrier_name?: string;
+    /** @description The carrier specific tracking identifier for this shipment. */
     tracking_number?: string;
+    /** @description This represents the ShipEngine supported status codes for a shipment. UN - Unknown AC - Accepted IT - In Transit DE - Delivered EX - Exception AT - Delivery Attempted NY - Not Yet In System */
     standardized_status_code: StandardizedStatusCodes;
+    /** @description The carrier specific status code of this shipment's tracking status. */
     carrier_status_code?: string;
+    /** @description The human readable description of this shipment's tracking status. */
     carrier_status_description?: string;
+    /** @description When the package(s) in this shipment were turned over to the carrier. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
     shipped_datetime?: string;
+    /** @description When the package(s) in this shipment are expected to arrive at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
     estimated_delivery_datetime?: string;
+    /** @description When the package(s) in this shipment arrived at their destination. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
     actual_delivery_datetime?: string;
+    /** @description A human readable description of why the shipment is in an error state. */
     shipping_problem_description?: string;
+    /** @description The weight measured by the carrier of the package(s) in this shipment. */
     weight?: number;
+    /** @description The dimensions measured by the carrier of the package(s) in this shipment. */
     dimensions?: Dimensions;
+    /** @description A shipping provider specific service. */
     service?: Service;
+    /** @description The carrier packaging code. */
     packaging?: string;
+    /** @description The carrier observed count of packages in this shipment. */
     package_count?: number;
+    /** @description A list of tracking events for this shipment */
     events?: TrackEvent[];
+    /** @description Whether or not this shipment has entered an error state. */
     shipping_problem?: boolean;
+    /** @description The unique identifying code for the type of error encountered by this shipment. */
     shipping_problem_code?: string;
+    /** @description The human readable explanation of the error encountered by this shipment. */
     error_description?: string;
 }
 export declare const TrackingInfoSchema: Joi.ObjectSchema<any>;

package/lib/models/tracking/tracking-info.js.map

@@ -1 +1 @@
-{"version":3,"file":"tracking-info.js","sourceRoot":"","sources":["../../../src/models/tracking/tracking-info.ts"],"names":[],"mappings":";;;;AAAA,2EAGqC;AACrC,oDAAmE;AACnE,uCAAmD;AACnD,+CAA6D;AAC7D,sDAAsB;AAEtB,4DAA4D;AAC5D,MAAa,YAAY;CAmBxB;AAnBD,oCAmBC;AAEY,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,wBAAwB,EAAE,yDAA6B,CAAC,QAAQ,EAAE;IAClE,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACpD,0BAA0B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3D,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC3D,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5D,wBAAwB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACnE,4BAA4B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7D,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACvC,UAAU,EAAE,6BAAgB,CAAC,QAAQ,EAAE;IACvC,OAAO,EAAE,uBAAa,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC1C,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9C,MAAM,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,8BAAgB,CAAC;IACtD,gBAAgB,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAClD,qBAAqB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtD,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACnD,CAAC,CAAC"}
+{"version":3,"file":"tracking-info.js","sourceRoot":"","sources":["../../../src/models/tracking/tracking-info.ts"],"names":[],"mappings":";;;;AAAA,2EAGqC;AACrC,oDAAmE;AACnE,uCAAmD;AACnD,+CAA6D;AAC7D,sDAAsB;AAEtB,4DAA4D;AAC5D,MAAa,YAAY;CAqCxB;AArCD,oCAqCC;AAEY,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,wBAAwB,EAAE,yDAA6B,CAAC,QAAQ,EAAE;IAClE,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACpD,0BAA0B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC3D,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC3D,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC5D,wBAAwB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACnE,4BAA4B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7D,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACvC,UAAU,EAAE,6BAAgB,CAAC,QAAQ,EAAE;IACvC,OAAO,EAAE,uBAAa,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC1C,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC9C,MAAM,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,8BAAgB,CAAC;IACtD,gBAAgB,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAClD,qBAAqB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IACtD,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACnD,CAAC,CAAC"}

package/lib/models/units/dimension-details.d.ts

@@ -2,8 +2,12 @@ import { Dimensions } from './dimensions';
 import { DimensionUnit } from './dimension-unit';
 /** @description Basic structure for package dimensions */
 export declare class DimensionDetails {
+    /** @description This contains information about the dimensions in centimeters. This will always be present on the request */
     dimensions_in_centimeters?: Dimensions;
+    /** @description This contains information about the dimensions in inches. This will always be present on the request */
     dimensions_in_inches?: Dimensions;
+    /** @description This contains information about the dimensions in the source units. This will always be present on the request */
     source_dimensions?: Dimensions;
+    /** @description The source units the customer provided */
     source_dimension_unit: DimensionUnit;
 }

package/lib/models/units/dimension-details.js.map

@@ -1 +1 @@
-{"version":3,"file":"dimension-details.js","sourceRoot":"","sources":["../../../src/models/units/dimension-details.ts"],"names":[],"mappings":";;;AAGA,0DAA0D;AAC1D,MAAa,gBAAgB;CAK5B;AALD,4CAKC"}
+{"version":3,"file":"dimension-details.js","sourceRoot":"","sources":["../../../src/models/units/dimension-details.ts"],"names":[],"mappings":";;;AAGA,0DAA0D;AAC1D,MAAa,gBAAgB;CAS5B;AATD,4CASC"}

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

@@ -1,8 +1,12 @@
 import { WeightUnit } from './weight-unit';
 /** @description Basic structure for weight */
 export declare class WeightDetails {
+    /** @description This contains information about the weight in ounces. This will always be present on the request */
     weight_in_ounces?: number;
+    /** @description This contains information about the weight in grams. This will always be present on the request */
     weight_in_grams?: number;
+    /** @description This contains information about the weight in source unit. This will always be present on the request */
     source_weight?: number;
+    /** @description The source units the customer provided */
     source_weight_unit: WeightUnit;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"weight-details.js","sourceRoot":"","sources":["../../../src/models/units/weight-details.ts"],"names":[],"mappings":";;;AAEA,8CAA8C;AAC9C,MAAa,aAAa;CAKzB;AALD,sCAKC"}
+{"version":3,"file":"weight-details.js","sourceRoot":"","sources":["../../../src/models/units/weight-details.ts"],"names":[],"mappings":";;;AAEA,8CAA8C;AAC9C,MAAa,aAAa;CASzB;AATD,sCASC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "2.2.2",
+  "version": "2.2.3",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://github.com/ShipEngine/connect",
   "main": "./lib/index.js",