@shipengine/connect-carrier-api 2.2.2 → 2.3.1

package/src/models/customs/customs-content-types.ts

@@ -1,9 +1,13 @@
 /** @description Denotes the type of content for customs  */
 export enum CustomsContentTypes {
+  /** @description This is generalized merchandise that someone has purchased */
   Merchandise = 'merchandise',
+  /** @description Documents that are being shipped */
   Documents = 'documents',
+  /** @description An item that is being shipped as a gift (not purchased) */
   Gift = 'gift',
-  /** @description e.g. a flooring sample */
+  /** @description Sample goods that are being shipped */
   Sample = 'sample',
+  /** @description Items that are being returned */
   ReturnedGoods = 'returned_goods',
 }

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

@@ -1,14 +1,22 @@
 import { Currency } from '../currency';
 import { WeightDetails } from '../units';
 
-/** @description Basic structure of an item in a customs declaration */
+/** @description This model represents the customs declaration for a single item */
 export class CustomsItem {
+  /** @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;
 }

package/src/models/customs/customs-non-delivery.ts

@@ -1,5 +1,7 @@
 /** @description Denotes the action that should be taken when a shipment is not deliverable */
 export enum CustomsNonDelivery {
+  /** @description Make an attempt to return this package to sender if unable to deliver */
   ReturnToSender = 'return_to_sender',
+  /** @description Do not make an attempt to return this package to sender if unable to deliver */
   TreatAsAbandoned = 'treat_as_abandoned',
 }

package/src/models/customs/customs.ts

@@ -3,11 +3,16 @@ import { CustomsNonDelivery } from './customs-non-delivery';
 import { CustomsItem } from './customs-item';
 import { Currency } from '../currency';
 
-/** @description Basic structure for a customs declaration. */
+/** @description Basic structure for a customs declaration */
 export class Customs {
+  /** @description Indicates the type of contents associated with this shipment */
   contents?: CustomsContentTypes;
+  /** @description Indicates what the seller would like done in case of an issue with delivery */
   non_delivery?: CustomsNonDelivery;
+  /** @description A list of customs items to declare */
   customs_items!: CustomsItem[];
+  /** @description Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper. */
   buyer_shipping_amount_paid?: Currency;
+  /** @description The amount of duties paid by the shipper, if any. This is generally only necessary for DDP (bill_duties_to_sender) shipments. */
   duties_paid?: Currency;
 }

package/src/models/documents/document-type.ts

@@ -2,12 +2,14 @@ import Joi from 'joi';
 
 /** @description Types of documents */
 export enum DocumentType {
+  /** @description A shipping label */
   Label = 'label',
+  /** @description A form that lists the details of goods that are being imported or exported when a citizen or visitor enters a customs territory (country's borders) */
   CustomsForm = 'customs_form',
+  /** @description A legal document issued by the seller (exporter) to the buyer (importer) in an international transaction and serves as a contract and a proof of sale between the buyer and seller */
   CommercialInvoice = 'commercial_invoice',
+  /** @description A legal document issued by a carrier to a shipper that details the type, quantity, and destination of the goods being carried (does not indicate the ownership of goods nor does it carry a title to the goods being sold) */
   BillOfLading = 'bill_of_lading',
 }
 
-export const DocumentTypeSchema = Joi.string().valid(
-  ...Object.values(DocumentType),
-);
+export const DocumentTypeSchema = Joi.string().valid(...Object.values(DocumentType));

package/src/models/documents/document.ts

@@ -1,14 +1,14 @@
 import { DocumentType, DocumentTypeSchema } from './document-type';
-import {
-  DocumentFormat,
-  DocumentFormatSchema,
-} from '../labels/document-formats';
+import { DocumentFormat, DocumentFormatSchema } from '../labels/document-formats';
 import Joi from 'joi';
 
 /** @description Basic structure for a document */
 export class Document {
+  /** @description The document type(s) being returned. In most cases this is just a single document type; however, some carriers return multiple document types in the same PDF or ZPL */
   type!: DocumentType[];
+  /** @description Base64 encoded data for the document */
   data!: string;
+  /** @description The format the document is in (Pdf, Zpl, etc) */
   format!: DocumentFormat;
 }
 export const DocumentSchema = Joi.object({

package/src/models/errors/detailed-error.ts

@@ -1,6 +1,6 @@
 import { StandardizedErrorCode } from './standardized-error-code';
 
-/** @description Basic structure for an error */
+/** @deprecated Please Use Runtime Errors */
 export class DetailedError {
   standardized_error_code!: StandardizedErrorCode;
   external_error_code?: string;

package/src/models/errors/standardized-error-code.ts

@@ -1,4 +1,4 @@
-/** @description Error codes for DetailedError */
+/** @deprecated Please Use Runtime Errors */
 export enum StandardizedErrorCode {
   Generic = 0,
   Serialization = 1,

package/src/models/fulfillment-plans/fulfillment-plan-details.ts

@@ -2,9 +2,12 @@ import { Identifier } from '../identifier';
 import { FulfillmentPlanItems } from './fulfillment-plan-items';
 import { RawExternalSource } from './raw-external-source';
 
-/** @description Basic structure for a fulfillment plan */
+/** @description This model contains information about the fulfillment plan. */
 export class FulfillmentPlanDetails {
+  /** @description A list of identifiers for the sales order. */
   external_sales_order_identifiers?: Identifier[];
+  /** @description Information about the fulfillment plan item. */
   items?: FulfillmentPlanItems[];
+  /** @description This model represents a raw external source of information */
   raw_external_source?: RawExternalSource;
 }

package/src/models/fulfillment-plans/fulfillment-plan-items.ts

@@ -2,12 +2,12 @@ import { Identifier } from '../identifier';
 
 /** @description Information about the fulfillment plan for a set of items */
 export class FulfillmentPlanItems {
-  /** @description List of identifiers for the sales order */
+  /** @description A list of identifiers for the sales order */
   external_sales_order_identifiers?: Identifier[];
-  /** @description List of identifiers specific to the selling channel */
+  /** @description A list of identifiers specific to the selling channel */
   external_product_identifiers?: Identifier[];
-  /** @description Name of the item */
+  /** @description The name of the item */
   name?: string;
-  /** @description Number of items */
+  /** @description The number of items */
   quantity?: number;
 }

package/src/models/fulfillment-plans/raw-external-source.ts

@@ -1,3 +1,5 @@
+/** @description This model represents a raw external source of information. */
 export class RawExternalSource {
+  /** @description Canonical representation of the fulfillment plan's and/or sales order's original source */
   marketplace_code?: string;
 }

package/src/models/labels/document-formats.ts

@@ -6,6 +6,4 @@ export enum DocumentFormat {
   Zpl = 'ZPL',
   Png = 'PNG',
 }
-export const DocumentFormatSchema = Joi.string().valid(
-  ...Object.values(DocumentFormat),
-);
+export const DocumentFormatSchema = Joi.string().valid(...Object.values(DocumentFormat));

package/src/models/labels/form-download.ts

@@ -1,7 +1,9 @@
 import Joi from 'joi';
 import { ResourceDownload, ResourceDownloadSchema } from '../resource-download';
 
+/** @description This provides any additional forms that go with the label. For example, customs forms. Exactly one of the keys should be populated. Set href is the forms should be downloaded separately. Set data if the forms are returned directly in the response. */
 export class FormDownload extends ResourceDownload {
+  /** @description The base64 encoded resource data. */
   form_data?: string;
 }
 

package/src/models/labels/label-download.ts

@@ -1,7 +1,9 @@
 import Joi from 'joi';
 import { ResourceDownload, ResourceDownloadSchema } from '../resource-download';
 
+/** @description This object provides the requested label that was just created. Exactly one of the keys should be populated. Set href if the label should be downloaded separately. Set data if the label is returned directly in the response. */
 export class LabelDownload extends ResourceDownload {
+  /** @description The base64 encoded resource data. */
   label_data?: string;
 }
 

package/src/models/labels/label-package.ts

@@ -4,9 +4,11 @@ import Joi from 'joi';
 
 /** @description Package information provided by the carrier */
 export class LabelPackage {
+  /** @description Tracking number for the package */
   tracking_number?: string;
   /** @description Non-tracking alternative ids associated with this package */
   alternative_identifiers?: Identifier[];
+  /** @description Documents associated with this package, if documents are not specified at a package level, use the Documents array at the CreateLabelResponse level. */
   documents?: Document[];
 }
 

package/src/models/labels/return-label-details.ts

@@ -1,4 +1,5 @@
 /** @description Basic structure for a return label */
 export class ReturnLabelDetails {
+  /** @description A return merchandise authorization (RMA) is an associated number assigned to process the return, this number is often printed on the label, and used when the original shipper processes the inbound return. */
   rma_number?: string;
 }

package/src/models/labels/void-request.ts

@@ -3,6 +3,8 @@ import { ShipFrom } from '../addresses';
 
 /** @description Basic structure for a request to void a label */
 export class VoidRequest extends ShippedShipment {
+  /** @description Uniquely identifies this request to void a label. Must be returned in a void response. */
   void_request_id!: string;
+  /** @description The location the shipment was shipped from */
   ship_from!: ShipFrom;
 }

package/src/models/labels/void-response.ts

@@ -8,7 +8,7 @@ export class VoidResponse {
   message?: string;
   /** @description Any errors from attempting to void */
   errors?: string[];
-  /** @description Individual Billing Line items which remain after voiding the label, e.g. a cancellation fee. */
+  /** @description Individual Billing Line items which remain after voiding the label, e.g. a cancellation fee */
   billing_line_items?: BillingLineItem[];
 }
 

package/src/models/manifests/label.ts

@@ -1,5 +1,7 @@
 /** @description Basic structure of a manifest label */
 export class Label {
+  /** @description The carrier tracking number for this shipment */
   tracking_number?: string;
+  /** @description The carrier specific identifier for this shipment */
   carrier_transaction_id?: string;
 }

package/src/models/manifests/manifest.ts

@@ -1,11 +1,15 @@
 import Joi from 'joi';
 import { ResourceDownload, ResourceDownloadSchema } from '../resource-download';
 
-/** @description Basic structure of a manifest */
+/** @description This model represents a single manifest created with a shipping provider. */
 export class Manifest {
+  /** @description The unique identifier for this manifest. */
   manifest_id?: string;
+  /** @description The resource and where it can be downloaded */
   document_download?: ResourceDownload;
+  /** @deprecated This property is no longer used please use the document_download */
   document_href?: string;
+  /** @deprecated This property is no longer used please use the document_download */
   document_data?: string;
 }
 

package/src/models/package.ts

@@ -7,10 +7,16 @@ import { Customs } from './customs';
 
 /** @description Basic structure for a package */
 export class Package {
+  /** @description Package code defined for the carrier in ShipEngine. */
   package_code?: string;
+  /** @description Details about the dimensions of the package */
   dimension_details?: DimensionDetails;
+  /** @description Details about the weight of the package */
   weight_details?: WeightDetails;
+  /** @description The insured value of this package. */
   insured_value!: Currency;
+  /** @description The message the seller requested to have on their label */
   label_messages?: LabelMessage;
+  /** @description Basic structure for a customs declaration (Only available on international shipments) */
   customs?: Customs;
 }

package/src/models/pickup/cancellation-details.ts

@@ -2,6 +2,7 @@ import { CancellationReason } from './cancellation-reason';
 
 /** @description Basic structure for a cancellation */
 export class CancellationDetails {
+  /** @description The reason the pickup has been cancelled */
   reason!: CancellationReason;
   /** @description Additional properties about cancellation */
   cancellation_options?: { [key: string]: string };

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

@@ -1,14 +1,14 @@
 import Joi from 'joi';
 import { Identifier, IdentifierSchema } from '../identifier';
-import {
-  ShipmentIdentifier,
-  ShipmentIdentifierSchema,
-} from './shipment-identifier';
+import { ShipmentIdentifier, ShipmentIdentifierSchema } from './shipment-identifier';
 
 /** @description Basic structure for a pickup confirmation */
 export class PickupConfirmation {
+  /** @description The primary confirmation ID for this request. */
   confirmation_id?: string;
+  /** @description Other identifiers potentially needed in other calls. */
   alternate_identifiers?: Identifier[];
+  /** @description List of the shipments added for this pickup. */
   shipment_identifiers?: ShipmentIdentifier[];
 }
 export const PickupConfirmationSchema = Joi.object({

package/src/models/pickup/pickup-contact-details.ts

@@ -1,8 +1,13 @@
-/** @description Contact details */
+/** @description Contact information for the person who will be present for the pickup. */
 export class PickupContactDetails {
+  /** @description The first name of the person who will be there for the pickup. */
   first_name!: string;
+  /** @description The last name of the person who will be there for the pickup. */
   last_name?: string;
+  /** @description The e-mail address of the person who will be there for the pickup. */
   email!: string;
+  /** @description The phone number of the person who will be there for the pickup. */
   phone_number!: string;
+  /** @description The phone extension of the person who will be there for the pickup. */
   phone_number_extension?: string;
 }

package/src/models/pickup/pickup-location-details.ts

@@ -2,6 +2,7 @@ import { ShipFrom } from '../addresses/ship-from';
 
 /** @description Location details for pickup */
 export class PickupLocationDetails {
+  /** @description The address the pickup will take place */
   pickup_address?: ShipFrom;
   /** @description Any notes that may be helpful for a driver to find the pickup location */
   location_notes?: string;

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

@@ -5,11 +5,18 @@ import { Dimensions } from '../units/dimensions';
 
 /** @description Basic structure for a package to be picked up */
 export class PickupPackage {
+  /** @description The carrier tracking number for this shipment */
   tracking_number?: string;
+  /** @description Alternative identifiers associated with this package */
   alternative_identifiers?: Identifier[];
+  /** @description Details about the dimensions of the package */
   dimension_details?: DimensionDetails;
+  /** @description Details about the weight of the package */
   weight_details?: WeightDetails;
+  /** @description The code associated with the package type */
   package_code?: string;
+  /** @deprectated Please use the weight_details property */
   weight?: number;
+  /** @deprectated Please use the dimension_details property */
   dimensions?: Dimensions;
 }

package/src/models/pickup/pickup-shipment-details.ts

@@ -2,6 +2,7 @@ import { ShippedShipment } from './shipped-shipment';
 
 /** @description Details for a pickup shipment */
 export class PickupShipmentDetails {
+  /** @description Service category for the carrier (ground, express, next_day) */
   pickup_service_code?: string;
   /** @description List of shipments to be picked up */
   shipments?: ShippedShipment[];

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

@@ -1,10 +1,14 @@
 import Joi from 'joi';
 
-/** @description Time window for pickup */
+/** @description This model represents a window of time a pickup could be made. */
 export class PickupWindow {
+  /** @description The local time zone represented in IANA. See https://www.iana.org/time-zones */
   time_zone_iana!: string;
+  /** @description The local date the pickup will occur. Formatted per https://tools.ietf.org/html/rfc3339 */
   pickup_date!: string;
+  /** @description The time relative to the time_zone_iana that the carrier says that the pickup could occur. Formatted per https://tools.ietf.org/html/rfc3339 */
   start_time?: string;
+  /** @description The end of the window when the pickup could be made relative to the time_zone_iana. Formatted per https://tools.ietf.org/html/rfc3339 */
   end_time?: string;
 }
 export const PickupWindowSchema = Joi.object({

package/src/models/pickup/shipment-identifier.ts

@@ -3,7 +3,9 @@ import { Identifier, IdentifierSchema } from '../identifier';
 
 /** @description Identifier object for shiments */
 export class ShipmentIdentifier {
+  /** @description The carrier tracking number for this shipment */
   tracking_number?: string;
+  /** @description A list of alternate identifiers that can be used to identify a shipment */
   alternate_identifiers?: Identifier[];
 }
 

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

@@ -5,11 +5,18 @@ import { Dimensions } from '../units/dimensions';
 
 /** @description Basic structure for a package that has been shipped */
 export class ShippedPackage {
+  /** @description The carrier tracking number associated with this package */
   tracking_number?: string;
+  /** @description Alternative identifiers associated with this package */
   alternative_identifiers?: Identifier[];
+  /** @description Details about the dimensions of the package */
   dimension_details?: DimensionDetails;
+  /** @description Details about the weight of the package */
   weight_details?: WeightDetails;
+  /** @description The code associated with the package type */
   package_code?: string;
+  /** @deprectated Please use the weight_details property */
   weight?: number;
+  /** @deprectated Please use the dimension_details property */
   dimensions?: Dimensions;
 }

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

@@ -6,11 +6,17 @@ import { ShippedPackage } from './shipped-package';
 
 /** @description Basic structure for a shipment that has been shipped */
 export class ShippedShipment extends Label {
+  /** @description The carrier tracking number associated with this package */
   tracking_number?: string;
+  /** @description The address that a shipment will be delivered to */
   ship_to?: ShipTo;
+  /** @description Non-tracking alternative ids associated with this shipment */
   alternative_identifiers?: Identifier[];
+  /** @description The service code used for this shipment */
   service_code?: string;
+  /** @description The list of packages associated with this shipment */
   packages?: ShippedPackage[];
+  /** @description Advanced shipping options (Contains Alcohol, Non Machinable, etc) */
   advanced_options?: AdvancedOptions;
 }
 

package/src/models/rates/rate.ts

@@ -1,12 +1,10 @@
 import Joi from 'joi';
-import {
-  BillingLineItem,
-  BillingLineItemSchema,
-} from '../billing/billing-line-item';
+import { BillingLineItem, BillingLineItemSchema } from '../billing/billing-line-item';
 import { TimeWindow, TimeWindowSchema } from '../time-window';
 
 /** @description Basic structure for a rate */
 export 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. */
   service_code?: string;
   /** @description ISO 8601 formatted date for shipment */
   ship_datetime?: string;
@@ -26,10 +24,7 @@ export class Rate {
   delivery_window?: TimeWindow;
   /** @description Unique identifier for the carrier rate */
   carrier_rate_id?: string;
-  /** @description DateTime after which the rate will no longer be accepted.
-   * ISO 8601 format, with local offset.
-   * Example: 2021-08-20T14:38:36.859237-05:00
-   */
+  /** @description DateTime after which the rate will no longer be accepted. ISO 8601 format, with local offset. Example: 2021-08-20T14:38:36.859237-05:00 */
   expiration_datetime?: string;
 }
 

package/src/models/registration/credentials.ts

@@ -2,7 +2,9 @@ import Joi from 'joi';
 
 /** @description Basic structure for credentials */
 export class Credentials {
+  /** @description The username, used as the unique identifier for the account */
   username!: string;
+  /** @description The password that will be sent in future requests */
   password!: string;
 }
 

package/src/models/resource-download.ts

@@ -2,7 +2,9 @@ import Joi from 'joi';
 
 /** @description Basic structure for a resource to download */
 export class ResourceDownload {
+  /** @deprecated This property is not used by the platform */
   href?: string;
+  /** @description Base64 encoded data for the resource */
   data?: string;
 }
 

package/src/models/taxes/tax-identifier.ts

@@ -1,6 +1,6 @@
 import { TaxIdentifierType } from './tax-identifier-type';
 
-/** @description Entity representing a Tax Identification number, type, and country of registration. */
+/** @description Entity representing a Tax Identification number, type, and country of registration */
 export class TaxIdentifier {
   /** @description Identification number */
   id!: string;

package/src/models/tracking/lat-long.ts

@@ -2,9 +2,9 @@ import Joi from 'joi';
 
 /** @description Latitude and longitude */
 export class LatLong {
-  /** @description latitude */
+  /** @description The latitude of the point. Represented as signed degrees. http://www.geomidpoint.com/latlon.html */
   lat!: number;
-  /** @description longitude */
+  /** @description The longitude of the point. Represented as signed degrees http://www.geomidpoint.com/latlon.html */
   long!: number;
 }
 

package/src/models/tracking/service.ts

@@ -2,7 +2,9 @@ import Joi from 'joi';
 
 /** @description Basic structure for a tracking service */
 export class Service {
+  /** @description The code specific to a shipping provider service. */
   code?: string;
+  /** @description The name of this shipping provider service. */
   name?: string;
 }
 export const ServiceSchema = Joi.object({

package/src/models/tracking/track-event.ts

@@ -5,20 +5,29 @@ import { StandardizedStatusCodes } from './standardized-status-codes';
 
 /** @description Basic structure for tracking events */
 export class TrackEvent {
+  /** @description When this tracking event occurred. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
   event_datetime?: string;
+  /** @description Most providers do not provide tracking events in UTC, and without time zone or geo information its hard to deduce. */
   event_datetime_local?: string;
+  /** @description Carrier's specific event code */
   event_code?: string;
+  /** @description Description of the package status at this event */
   description?: string;
+  /** @description City or Locality for this event */
   city?: string;
   /** @description State or province */
   state?: string;
   /** @description Zip or postal code */
   postal_code?: string;
+  /** @description Country for this event */
   country?: string;
+  /** @description The name of the company this is being delivered to */
   company?: string;
+  /** @description If the event had a signer associated, normally on delivery */
   signer?: string;
   /** @description Geographical location */
   geo?: LatLong;
+  /** @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 */
   status_code?: StandardizedStatusCodes;
 }
 export const TrackEventSchema = Joi.object({

package/src/models/tracking/tracking-info.ts

@@ -9,23 +9,41 @@ import Joi from 'joi';
 
 /** @description Basic structure for tracking information */
 export 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;
 }
 

package/src/models/tracking/update-method.ts

@@ -8,6 +8,4 @@ export enum UpdateMethods {
   Replace = 'replace',
 }
 
-export const UpdateMethodsSchema = Joi.string().valid(
-  ...Object.values(UpdateMethods),
-);
+export const UpdateMethodsSchema = Joi.string().valid(...Object.values(UpdateMethods));

package/src/models/units/dimension-details.ts

@@ -3,8 +3,12 @@ import { DimensionUnit } from './dimension-unit';
 
 /** @description Basic structure for package dimensions */
 export 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/src/models/units/weight-details.ts

@@ -2,8 +2,12 @@ import { WeightUnit } from './weight-unit';
 
 /** @description Basic structure for weight */
 export 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;
 }