@shipengine/connect-carrier-api 2.1.21 → 2.1.22

package/src/app/constants.ts

@@ -0,0 +1,14 @@
+export enum ApiEndpoints {
+  Register = '/Register',
+  CreateLabel = '/CreateLabel',
+  VoidLabels = '/VoidLabels',
+  GetRates = '/GetRates',
+  CreateManifest = '/CreateManifest',
+  SchedulePickup = '/SchedulePickup',
+  CancelPickup = '/CancelPickup',
+  Track = '/Track',
+  CreateNotification = '/CreateNotification',
+  CancelNotification = '/CancelNotification',
+  ValidateInboundData = '/ValidateInboundData',
+  NormalizeTrackingData = '/NormalizeTrackingData',
+}

package/src/app/internal/route.ts

@@ -10,4 +10,5 @@ export interface Route {
   path: string;
   method: Method;
   handler?: (req: any) => any | Promise<any>;
+  validateResponse?: (response: any) => string[] | undefined;
 }

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

@@ -1,3 +1,5 @@
+import Joi from 'joi';
+
 /** @description Category for a billing line item */
 export enum BillingCategories {
   Uncategorized = 'uncategorized',
@@ -23,3 +25,7 @@ export enum BillingCategories {
   /** @description Amount to be paid to the driver, used for local delivery and courier services. */
   Tip = 'tip',
 }
+
+export const BillingCategoriesSchema = Joi.string().valid(
+  ...Object.values(BillingCategories),
+);

package/src/models/billing/billing-line-item.ts

@@ -1,5 +1,9 @@
-import { BillingCategories } from './billing-categories';
-import { Currency } from '../currency';
+import {
+  BillingCategories,
+  BillingCategoriesSchema,
+} from './billing-categories';
+import { Currency, CurrencySchema } from '../currency';
+import Joi from 'joi';
 
 /** @description Basic structure of each charge or line item */
 export class BillingLineItem {
@@ -9,3 +13,11 @@ export class BillingLineItem {
   memo?: string;
   amount!: Currency;
 }
+
+export const BillingLineItemSchema = Joi.object({
+  billing_category: BillingCategoriesSchema.required(),
+  carrier_description: Joi.string().optional().empty(),
+  carrier_billing_code: Joi.string().optional().empty(),
+  memo: Joi.string().optional().empty(),
+  amount: CurrencySchema.required(),
+});

package/src/models/currency.ts

@@ -1,5 +1,12 @@
+import Joi from 'joi';
+
 /** @description Basic structure for defining an amount of money and its currency */
 export class Currency {
   currency!: string;
   amount!: string;
 }
+
+export const CurrencySchema = Joi.object({
+  currency: Joi.string().required(),
+  amount: Joi.string().required(),
+});

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

@@ -1,3 +1,5 @@
+import Joi from 'joi';
+
 /** @description Types of documents */
 export enum DocumentType {
   Label = 'label',
@@ -5,3 +7,7 @@ export enum DocumentType {
   CommercialInvoice = 'commercial_invoice',
   BillOfLading = 'bill_of_lading',
 }
+
+export const DocumentTypeSchema = Joi.string().valid(
+  ...Object.values(DocumentType),
+);

package/src/models/documents/document.ts

@@ -1,5 +1,9 @@
-import { DocumentType } from './document-type';
-import { DocumentFormat } from '../labels/document-formats';
+import { DocumentType, DocumentTypeSchema } from './document-type';
+import {
+  DocumentFormat,
+  DocumentFormatSchema,
+} from '../labels/document-formats';
+import Joi from 'joi';
 
 /** @description Basic structure for a document */
 export class Document {
@@ -7,3 +11,8 @@ export class Document {
   data!: string;
   format!: DocumentFormat;
 }
+export const DocumentSchema = Joi.object({
+  type: Joi.array().required().min(1).items(DocumentTypeSchema),
+  data: Joi.string().required(),
+  format: DocumentFormatSchema.required(),
+});

package/src/models/identifier.ts

@@ -1,5 +1,12 @@
+import Joi from 'joi';
+
 /** @description Key value pair to allow custom properties */
 export class Identifier {
   type!: string;
   value!: string;
 }
+
+export const IdentifierSchema = Joi.object({
+  type: Joi.string().required(),
+  value: Joi.string().required(),
+});

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

@@ -1,5 +1,10 @@
+import Joi from 'joi';
+
 /** @description Types of inbound content */
 export enum InboundDataContentTypes {
   /** @description Tracking information */
   Tracking = 'tracking',
 }
+export const InboundDataContentTypesSchema = Joi.string().valid(
+  ...Object.values(InboundDataContentTypes),
+);

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

@@ -1,6 +1,11 @@
+import Joi from 'joi';
+
 /** @description Label data type */
 export enum DocumentFormat {
   Pdf = 'PDF',
   Zpl = 'ZPL',
   Png = 'PNG',
 }
+export const DocumentFormatSchema = Joi.string().valid(
+  ...Object.values(DocumentFormat),
+);

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

@@ -1,5 +1,10 @@
-import { ResourceDownload } from '../resource-download';
+import Joi from 'joi';
+import { ResourceDownload, ResourceDownloadSchema } from '../resource-download';
 
 export class FormDownload extends ResourceDownload {
   form_data?: string;
 }
+
+export const FormDownloadSchema = ResourceDownloadSchema.keys({
+  form_data: Joi.string().optional().empty(),
+});

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

@@ -1,5 +1,10 @@
-import { ResourceDownload } from '../resource-download';
+import Joi from 'joi';
+import { ResourceDownload, ResourceDownloadSchema } from '../resource-download';
 
 export class LabelDownload extends ResourceDownload {
   label_data?: string;
 }
+
+export const LabelDownloadSchema = ResourceDownloadSchema.keys({
+  label_data: Joi.string().optional().empty(),
+});

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

@@ -1,5 +1,6 @@
-import { Identifier } from '../identifier';
-import { Document } from '../documents';
+import { Identifier, IdentifierSchema } from '../identifier';
+import { Document, DocumentSchema } from '../documents';
+import Joi from 'joi';
 
 /** @description Package information provided by the carrier */
 export class LabelPackage {
@@ -8,3 +9,9 @@ export class LabelPackage {
   alternative_identifiers?: Identifier[];
   documents?: Document[];
 }
+
+export const LabelPackageSchema = Joi.object({
+  tracking_number: Joi.string().optional().empty(),
+  alternative_identifiers: Joi.array().optional().items(IdentifierSchema),
+  documents: Joi.array().optional().items(DocumentSchema),
+});

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

@@ -1,5 +1,5 @@
-import { BillingLineItem } from '..';
-
+import Joi from 'joi';
+import { BillingLineItem, BillingLineItemSchema } from '../billing';
 /** @description Basic structure for a response to void a label */
 export class VoidResponse {
   /** @description Id for the void response */
@@ -11,3 +11,10 @@ export class VoidResponse {
   /** @description Individual Billing Line items which remain after voiding the label, e.g. a cancellation fee. */
   billing_line_items?: BillingLineItem[];
 }
+
+export const VoidResponseSchema = Joi.object({
+  void_request_id: Joi.string().required(),
+  message: Joi.string().optional().empty(),
+  errors: Joi.array().optional().items(Joi.string()),
+  billing_line_items: Joi.array().optional().items(BillingLineItemSchema),
+});

package/src/models/manifests/manifest.ts

@@ -1,4 +1,5 @@
-import { ResourceDownload } from '../resource-download';
+import Joi from 'joi';
+import { ResourceDownload, ResourceDownloadSchema } from '../resource-download';
 
 /** @description Basic structure of a manifest */
 export class Manifest {
@@ -7,3 +8,10 @@ export class Manifest {
   document_href?: string;
   document_data?: string;
 }
+
+export const ManifestSchema = Joi.object({
+  manifest_id: Joi.string().optional().empty(),
+  document_download: ResourceDownloadSchema.optional(),
+  document_href: Joi.string().optional().empty(),
+  document_data: Joi.string().optional().empty(),
+});

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

@@ -1,5 +1,9 @@
-import { Identifier } from '../identifier';
-import { ShipmentIdentifier } from './shipment-identifier';
+import Joi from 'joi';
+import { Identifier, IdentifierSchema } from '../identifier';
+import {
+  ShipmentIdentifier,
+  ShipmentIdentifierSchema,
+} from './shipment-identifier';
 
 /** @description Basic structure for a pickup confirmation */
 export class PickupConfirmation {
@@ -7,3 +11,8 @@ export class PickupConfirmation {
   alternate_identifiers?: Identifier[];
   shipment_identifiers?: ShipmentIdentifier[];
 }
+export const PickupConfirmationSchema = Joi.object({
+  confirmation_id: Joi.string().optional().empty(),
+  alternate_identifiers: Joi.array().optional().items(IdentifierSchema),
+  shipment_identifiers: Joi.array().optional().items(ShipmentIdentifierSchema),
+});

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

@@ -1,3 +1,5 @@
+import Joi from 'joi';
+
 /** @description Time window for pickup */
 export class PickupWindow {
   time_zone_iana!: string;
@@ -5,3 +7,9 @@ export class PickupWindow {
   start_time?: string;
   end_time?: string;
 }
+export const PickupWindowSchema = Joi.object({
+  time_zone_iana: Joi.string().required(),
+  pickup_date: Joi.string().required().isoDate(),
+  start_time: Joi.string().optional().isoDate(),
+  end_time: Joi.string().optional().isoDate(),
+});

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

@@ -1,7 +1,13 @@
-import { Identifier } from '../identifier';
+import Joi from 'joi';
+import { Identifier, IdentifierSchema } from '../identifier';
 
 /** @description Identifier object for shiments */
 export class ShipmentIdentifier {
   tracking_number?: string;
   alternate_identifiers?: Identifier[];
 }
+
+export const ShipmentIdentifierSchema = Joi.object({
+  tracking_number: Joi.string().optional().empty(),
+  alternate_identifiers: Joi.array().optional().items(IdentifierSchema),
+});

package/src/models/rates/rate.ts

@@ -1,5 +1,9 @@
-import { BillingLineItem } from '../billing/billing-line-item';
-import { TimeWindow } from '../time-window';
+import Joi from 'joi';
+import {
+  BillingLineItem,
+  BillingLineItemSchema,
+} from '../billing/billing-line-item';
+import { TimeWindow, TimeWindowSchema } from '../time-window';
 
 /** @description Basic structure for a rate */
 export class Rate {
@@ -28,3 +32,17 @@ export class Rate {
    */
   expiration_datetime?: string;
 }
+
+export const RateSchema = Joi.object({
+  service_code: Joi.string().optional().empty(),
+  ship_datetime: Joi.string().optional().empty().isoDate(),
+  estimated_delivery_datetime: Joi.string().optional().empty().isoDate(),
+  billing_line_items: Joi.array().optional().items(BillingLineItemSchema),
+  error_messages: Joi.array().optional().items(Joi.string()),
+  warning_messages: Joi.array().optional().items(Joi.string()),
+  negotiated_rate: Joi.boolean().optional(),
+  carrier_pickup_window: TimeWindowSchema.optional(),
+  delivery_window: TimeWindowSchema.optional(),
+  carrier_rate_id: Joi.string().optional().empty(),
+  expiration_datetime: Joi.string().optional().empty().isoDate(),
+});

package/src/models/registration/credentials.ts

@@ -1,5 +1,12 @@
+import Joi from 'joi';
+
 /** @description Basic structure for credentials */
 export class Credentials {
   username!: string;
   password!: string;
 }
+
+export const CredentialsSchema = Joi.object({
+  username: Joi.string().required(),
+  password: Joi.string().required(),
+});

package/src/models/resource-download.ts

@@ -1,5 +1,12 @@
+import Joi from 'joi';
+
 /** @description Basic structure for a resource to download */
 export class ResourceDownload {
   href?: string;
   data?: string;
 }
+
+export const ResourceDownloadSchema = Joi.object({
+  href: Joi.string().optional().empty(),
+  data: Joi.string().optional().empty(),
+});

package/src/models/time-window.ts

@@ -1,3 +1,5 @@
+import Joi from 'joi';
+
 /** @description Basic structure for defining a time window */
 export class TimeWindow {
   /** @description The local time zone represented in IANA. See https://www.iana.org/time-zones.
@@ -15,3 +17,9 @@ export class TimeWindow {
    */
   end_window?: string;
 }
+
+export const TimeWindowSchema = Joi.object({
+  time_zone_iana: Joi.string().required(),
+  start_window: Joi.string().required().isoDate(),
+  end_window: Joi.string().optional().empty().isoDate(),
+});

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

@@ -1,3 +1,5 @@
+import Joi from 'joi';
+
 /** @description Latitude and longitude */
 export class LatLong {
   /** @description latitude */
@@ -5,3 +7,8 @@ export class LatLong {
   /** @description longitude */
   long!: number;
 }
+
+export const LatLongSchema = Joi.object({
+  lat: Joi.number().required(),
+  long: Joi.number().required(),
+});

package/src/models/tracking/service.ts

@@ -1,5 +1,11 @@
+import Joi from 'joi';
+
 /** @description Basic structure for a tracking service */
 export class Service {
   code?: string;
   name?: string;
 }
+export const ServiceSchema = Joi.object({
+  code: Joi.string().optional().empty(),
+  name: Joi.string().optional().empty(),
+});

package/src/models/tracking/standardized-status-codes.ts

@@ -1,3 +1,5 @@
+import Joi from 'joi';
+
 /** @description Status codes for tracking */
 export enum StandardizedStatusCodes {
   Unknown = 'UN',
@@ -8,3 +10,7 @@ export enum StandardizedStatusCodes {
   DeliveryAttempt = 'AT',
   NotYetInSystem = 'NY',
 }
+
+export const StandardizedStatusCodesSchema = Joi.string().valid(
+  ...Object.values(StandardizedStatusCodes),
+);

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

@@ -1,3 +1,5 @@
+import Joi from 'joi';
+import { LatLongSchema, StandardizedStatusCodesSchema } from '.';
 import { LatLong } from './lat-long';
 import { StandardizedStatusCodes } from './standardized-status-codes';
 
@@ -19,3 +21,17 @@ export class TrackEvent {
   geo?: LatLong;
   status_code?: StandardizedStatusCodes;
 }
+export const TrackEventSchema = Joi.object({
+  event_datetime: Joi.string().optional().empty().isoDate(),
+  event_datetime_local: Joi.string().optional().empty().isoDate(),
+  event_code: Joi.string().optional().empty(),
+  description: Joi.string().optional().empty(),
+  city: Joi.string().optional().empty(),
+  state: Joi.string().optional().empty(),
+  postal_code: Joi.string().optional().empty(),
+  country: Joi.string().optional().empty(),
+  company: Joi.string().optional().empty(),
+  signer: Joi.string().optional().empty(),
+  geo: LatLongSchema.optional(),
+  status_code: StandardizedStatusCodesSchema.optional(),
+});

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

@@ -1,7 +1,11 @@
-import { StandardizedStatusCodes } from './standardized-status-codes';
-import { Dimensions } from '../units/dimensions';
-import { Service } from './service';
-import { TrackEvent } from './track-event';
+import {
+  StandardizedStatusCodes,
+  StandardizedStatusCodesSchema,
+} from './standardized-status-codes';
+import { Dimensions, DimensionsSchema } from '../units/dimensions';
+import { Service, ServiceSchema } from './service';
+import { TrackEvent, TrackEventSchema } from './track-event';
+import Joi from 'joi';
 
 /** @description Basic structure for tracking information */
 export class TrackingInfo {
@@ -24,3 +28,24 @@ export class TrackingInfo {
   shipping_problem_code?: string;
   error_description?: string;
 }
+
+export const TrackingInfoSchema = Joi.object({
+  carrier_name: Joi.string().optional().empty(),
+  tracking_number: Joi.string().optional().empty(),
+  standardized_status_code: StandardizedStatusCodesSchema.required(),
+  carrier_status_code: Joi.string().optional().empty(),
+  carrier_status_description: Joi.string().optional().empty(),
+  shipped_datetime: Joi.string().optional().empty().isoDate(),
+  estimated_delivery_datetime: Joi.string().optional().empty(),
+  actual_delivery_datetime: Joi.string().optional().empty().isoDate(),
+  shipping_problem_description: Joi.string().optional().empty(),
+  weight: Joi.number().optional().empty(),
+  dimensions: DimensionsSchema.optional(),
+  service: ServiceSchema.optional(),
+  packaging: Joi.string().optional().empty(),
+  package_count: Joi.number().optional().empty(),
+  events: Joi.array().optional().items(TrackEventSchema),
+  shipping_problem: Joi.boolean().optional().empty(),
+  shipping_problem_code: Joi.string().optional().empty(),
+  error_description: Joi.string().optional().empty(),
+});

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

@@ -1,3 +1,5 @@
+import Joi from 'joi';
+
 /** @description Update method to use for the tracking information */
 export enum UpdateMethods {
   /** @description Append the new data to the existing data set */
@@ -5,3 +7,7 @@ export enum UpdateMethods {
   /** @description Replace the existing data set with the new data */
   Replace = 'replace',
 }
+
+export const UpdateMethodsSchema = Joi.string().valid(
+  ...Object.values(UpdateMethods),
+);

package/src/models/units/dimensions.ts

@@ -1,6 +1,13 @@
+import Joi from 'joi';
+
 /** @description Basic structure for dimensions */
 export class Dimensions {
   length?: number;
   width?: number;
   height?: number;
 }
+export const DimensionsSchema = Joi.object({
+  length: Joi.number().optional(),
+  width: Joi.number().optional(),
+  height: Joi.number().optional(),
+});

package/src/responses/base-response.ts

@@ -1,3 +1,9 @@
+import Joi from 'joi';
+
 export class BaseResponse {
   metadata?: { [key: string]: any };
 }
+
+export const BaseResponseSchema = Joi.object({
+  metadata: Joi.object().pattern(/.*/, [Joi.any()]).optional(),
+});

package/src/responses/cancel-notification-response.ts

@@ -1,4 +1,5 @@
-import { BaseResponse } from './base-response';
+import Joi from 'joi';
+import { BaseResponse, BaseResponseSchema } from './base-response';
 
 export class CancelNotificationResponse extends BaseResponse {
   /** @description User facing text describing the cancellation process. May be left blank to present a default value */
@@ -6,3 +7,8 @@ export class CancelNotificationResponse extends BaseResponse {
   /** @description A list of errors preventing this notification from being cancelled. If no errors are returned the void is considered successful. If  any errors are returned the void is considered failed. */
   errors?: string[];
 }
+
+export const CancelNotificationResponseSchema = BaseResponseSchema.keys({
+  message: Joi.string().optional().empty(),
+  errors: Joi.array().optional().items(Joi.string()),
+});

package/src/responses/cancel-pickup-response.ts

@@ -1,4 +1,5 @@
-import { BaseResponse } from './base-response';
+import Joi from 'joi';
+import { BaseResponse, BaseResponseSchema } from './base-response';
 
 /** @description Basic structure for a response to cancel pickup */
 export class CancelPickupResponse extends BaseResponse {
@@ -7,3 +8,10 @@ export class CancelPickupResponse extends BaseResponse {
   status?: string;
   custom_properties?: { [key: string]: string };
 }
+
+export const CancelPickupResponseSchema = BaseResponseSchema.keys({
+  confirmationa_id: Joi.string().optional(),
+  successful: Joi.boolean().required(),
+  status: Joi.string().optional().empty(),
+  custom_properties: Joi.object().pattern(/.*/, [Joi.string()]).optional(),
+});

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

@@ -1,4 +1,4 @@
-import { BaseResponse } from './base-response';
+import { BaseResponse, BaseResponseSchema } from './base-response';
 import {
   LabelDownload,
   FormDownload,
@@ -7,7 +7,15 @@ import {
   LabelPackage,
   Identifier,
   TimeWindow,
+  LabelDownloadSchema,
+  FormDownloadSchema,
+  DocumentSchema,
+  LabelPackageSchema,
+  BillingLineItemSchema,
+  IdentifierSchema,
+  TimeWindowSchema,
 } from '../models';
+import Joi from 'joi';
 
 /** @description Basic structure for a response to create a label */
 export class CreateLabelResponse extends BaseResponse {
@@ -27,3 +35,19 @@ export class CreateLabelResponse extends BaseResponse {
   /** @description The delivery window is the time designated when the carrier will drop off the package to the recipient */
   delivery_window?: TimeWindow;
 }
+
+export const CreateLabelResponseSchema = BaseResponseSchema.keys({
+  transaction_id: Joi.string().required(),
+  label_download: LabelDownloadSchema.optional(),
+  form_download: FormDownloadSchema.optional(),
+  documents: Joi.array().optional().items(DocumentSchema),
+  packages: Joi.array().optional().items(LabelPackageSchema),
+  billing_line_items: Joi.array().optional().items(BillingLineItemSchema),
+  tracking_number: Joi.string().optional().empty(),
+  trackable: Joi.boolean().optional(),
+  alternative_identifiers: Joi.array().optional().items(IdentifierSchema),
+  estimated_delivery_datetime: Joi.string().optional().empty().isoDate(),
+  consolidator_service_code: Joi.string().optional().empty(),
+  carrier_pickup_window: TimeWindowSchema.optional(),
+  delivery_window: TimeWindowSchema.optional(),
+});

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

@@ -1,8 +1,14 @@
-import { BaseResponse } from './base-response';
-import { Manifest } from '../models';
+import { BaseResponse, BaseResponseSchema } from './base-response';
+import { Manifest, ManifestSchema } from '../models';
+import Joi from 'joi';
 
 /** @description Basic structure for a response to create a manifest */
 export class CreateManifestResponse extends BaseResponse {
   transaction_id!: string;
   manifests?: Manifest[];
 }
+
+export const CreateManifestResponseSchema = BaseResponseSchema.keys({
+  transaction_id: Joi.string().required(),
+  manifests: Joi.array().optional().items(ManifestSchema),
+});

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

@@ -1,6 +1,11 @@
-import { BaseResponse } from './base-response';
+import Joi from 'joi';
+import { BaseResponse, BaseResponseSchema } from './base-response';
 
 export class CreateNotificationResponse extends BaseResponse {
   /** @description The id of the sucessfully created notification*/
   notification_id!: string;
 }
+
+export const CreateNotificationResponseSchema = BaseResponseSchema.keys({
+  notification_id: Joi.string().required(),
+});

package/src/responses/get-rates-response.ts

@@ -1,7 +1,12 @@
-import { BaseResponse } from './base-response';
-import { Rate } from '../models';
+import { BaseResponse, BaseResponseSchema } from './base-response';
+import { Rate, RateSchema } from '../models';
+import Joi from 'joi';
 
 /** @description Basic structure for a response to get rates */
 export class GetRatesResponse extends BaseResponse {
   rates!: Rate[];
 }
+
+export const GetRatesResponseSchema = BaseResponseSchema.keys({
+  rates: Joi.array().required().items(RateSchema),
+});