@shipengine/connect-carrier-api 2.1.18 → 2.1.22

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

@@ -0,0 +1,13 @@
+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 */
+  Append = 'append',
+  /** @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/requests/base-request.ts

@@ -1,4 +1,7 @@
+import { Authorization } from '../models';
+
 export class BaseRequest {
   transaction_id!: string;
+  authorization?: Authorization;
   metadata?: { [key: string]: any };
 }

package/src/requests/index.ts

@@ -8,3 +8,5 @@ export * from './tracking-request';
 export * from './void-labels-request';
 export * from './create-notification-request';
 export * from './cancel-notification-request';
+export * from './validate-inbound-data-request';
+export * from './normalize-tracking-data-request';

package/src/requests/normalize-tracking-data-request.ts

@@ -0,0 +1,9 @@
+import { BaseRequest } from './base-request';
+
+/** @description Basic structure for a request to normalize tracking data from inbound tracking data requests (e.g. webhooks) */
+export interface NormalizeTrackingDataRequest extends BaseRequest {
+  /** @description The request's data, e.g. the body of the webhook http request */
+  data: string;
+  /** @description Headers sent with the inbound request if it was received via http */
+  headers: Record<string, string[]>;
+}

package/src/requests/validate-inbound-data-request.ts

@@ -0,0 +1,9 @@
+import { BaseRequest } from './base-request';
+
+/** @description Basic structure for a request to validate inbound data */
+export interface ValidateInboundDataRequest extends BaseRequest {
+  /** @description The request's data, e.g. the body of the webhook http request */
+  data: string;
+  /** @description Headers sent with the inbound request if it was received via http */
+  headers: Record<string, string[]>;
+}

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),
+});

package/src/responses/index.ts

@@ -9,3 +9,5 @@ export * from './void-labels-response';
 export * from './error-response';
 export * from './cancel-notification-response';
 export * from './create-notification-response';
+export * from './validate-inbound-data-response';
+export * from './normalize-tracking-data-response';

package/src/responses/normalize-tracking-data-response.ts

@@ -0,0 +1,24 @@
+import { BaseResponse, BaseResponseSchema } from './base-response';
+import {
+  UpdateMethods,
+  TrackingInfo,
+  TrackingInfoSchema,
+  UpdateMethodsSchema,
+} from '../models';
+import Joi from 'joi';
+
+/** @description Basic structure for a response to normalize inbound tracking data */
+export class NormalizeTrackingDataResponse extends BaseResponse {
+  /** @description Collection of normalized tracking updates with one entry per package */
+  tracking_info!: TrackingInfo[];
+  /**
+   * @description Method for updating the tracking information state, i.e. is the returned information
+   * the complete state of the package or should it be appended to the existing state
+   */
+  update_method!: UpdateMethods;
+}
+
+export const NormalizeTrackingDataResponseSchema = BaseResponseSchema.keys({
+  tracking_info: Joi.array().required().items(TrackingInfoSchema),
+  update_method: UpdateMethodsSchema,
+});

package/src/responses/register-response.ts

@@ -1,7 +1,12 @@
-import { Credentials } from '../models';
+import Joi from 'joi';
+import { Credentials, CredentialsSchema } from '../models';
 
 /** @description Basic structure for a response to register/connect */
 export class RegisterResponse {
   credentials!: Credentials;
   metadata!: object;
 }
+export const RegisterResponseSchema = Joi.object({
+  credentials: CredentialsSchema.required(),
+  metadata: Joi.object().pattern(/.*/, [Joi.any()]).required(),
+});

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

@@ -1,5 +1,13 @@
-import { BaseResponse } from './base-response';
-import { PickupConfirmation, PickupWindow, BillingLineItem } from '../models';
+import { BaseResponse, BaseResponseSchema } from './base-response';
+import {
+  PickupConfirmation,
+  PickupWindow,
+  BillingLineItem,
+  PickupConfirmationSchema,
+  PickupWindowSchema,
+  BillingLineItemSchema,
+} from '../models';
+import Joi from 'joi';
 
 /** @description Basic structure for a response to schedule a pickup */
 export class SchedulePickupResponse extends BaseResponse {
@@ -9,3 +17,11 @@ export class SchedulePickupResponse extends BaseResponse {
   custom_properties?: { [key: string]: string };
   billing_line_items?: BillingLineItem[];
 }
+
+export const SchedulePickupResponseSchema = BaseResponseSchema.keys({
+  confirmation: PickupConfirmationSchema.optional(),
+  pickup_windows: Joi.array().optional().items(PickupWindowSchema),
+  remarks: Joi.string().optional().empty(),
+  custom_properties: Joi.object().pattern(/.*/, [Joi.string()]).optional(),
+  billing_line_items: Joi.array().optional().items(BillingLineItemSchema),
+});

package/src/responses/tracking-response.ts

@@ -1,7 +1,11 @@
-import { BaseResponse } from './base-response';
-import { TrackingInfo } from '../models';
+import { BaseResponse, BaseResponseSchema } from './base-response';
+import { TrackingInfo, TrackingInfoSchema } from '../models';
 
 /** @description Basic structure for a response to get tracking information */
 export class TrackingResponse extends BaseResponse {
   tracking_info!: TrackingInfo;
 }
+
+export const TrackingResponseSchema = BaseResponseSchema.keys({
+  tracking_info: TrackingInfoSchema.required(),
+});

package/src/responses/validate-inbound-data-response.ts

@@ -0,0 +1,16 @@
+import { BaseResponse, BaseResponseSchema } from './base-response';
+import {
+  InboundDataContentTypes,
+  InboundDataContentTypesSchema,
+} from '../models';
+import Joi from 'joi';
+
+/** @description Basic structure for a response to validate inbound data */
+export class ValidateInboundDataResponse extends BaseResponse {
+  /** @description List of content types included in the data */
+  content_types!: InboundDataContentTypes[];
+}
+
+export const ValidateInboundDataResponseSchema = BaseResponseSchema.keys({
+  content_types: Joi.array().required().items(InboundDataContentTypesSchema),
+});

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

@@ -1,8 +1,13 @@
-import { BaseResponse } from './base-response';
-import { VoidResponse } from '../models';
+import { BaseResponse, BaseResponseSchema } from './base-response';
+import { VoidResponse, VoidResponseSchema } from '../models';
+import Joi from 'joi';
 
 /** @description Basic structure for a response to void labels */
 export class VoidLabelsResponse extends BaseResponse {
   /** @description List of void responses*/
   void_responses!: VoidResponse[];
 }
+
+export const VoidLabelsResponseSchema = BaseResponseSchema.keys({
+  void_responses: Joi.array().required().items(VoidResponseSchema),
+});