@shipengine/connect-carrier-api 2.3.3 → 2.4.0

package/src/app/carrier-app-definition.ts

@@ -3,6 +3,7 @@ import {
   CreateLabelRequest,
   VoidLabelsRequest,
   CreateManifestRequest,
+  GetManifestRequest,
   SchedulePickupRequest,
   CancelPickupRequest,
   GetRatesRequest,
@@ -11,6 +12,7 @@ import {
   CreateNotificationRequest,
   ValidateInboundDataRequest,
   NormalizeTrackingDataRequest,
+  GetRelayPointsRequest,
 } from '../requests';
 
 import {
@@ -26,6 +28,7 @@ import {
   CreateNotificationResponse,
   ValidateInboundDataResponse,
   NormalizeTrackingDataResponse,
+  GetRelayPointsResponse,
 } from '../responses';
 
 import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
@@ -57,6 +60,13 @@ export interface CarrierAppDefinition {
   CreateManifest?: (
     request: CreateManifestRequest,
   ) => CreateManifestResponse | Promise<CreateManifestResponse>;
+  /**
+   * @description This method is used to retrieve a manifest with a carrier
+   * @param request Data needed by the provider to retrieve a previousely created manifest
+   */
+  GetManifest?: (
+    request: GetManifestRequest,
+  ) => CreateManifestResponse | Promise<CreateManifestResponse>;
   /**
    * @description This endpoint is used to schedule an adhoc pickup with the shipping provider
    * @param request Data needed by the provider to schedule adhoc pickups
@@ -109,4 +119,11 @@ export interface CarrierAppDefinition {
   NormalizeTrackingData?: (
     request: NormalizeTrackingDataRequest,
   ) => NormalizeTrackingDataResponse | Promise<NormalizeTrackingDataResponse>;
+  /**
+   * @description This endpoint is used to get all relay points for carrier
+   * @param request Data needed by the provider about the relay points to be returned
+   */
+  GetRelayPoints?: (
+    request: GetRelayPointsRequest,
+  ) => GetRelayPointsResponse | Promise<GetRelayPointsResponse>;
 }

package/src/app/carrier-app.ts

@@ -19,6 +19,7 @@ import {
   CreateNotificationResponseSchema,
   ValidateInboundDataResponseSchema,
   NormalizeTrackingDataResponseSchema,
+  GetRelayPointsResponseSchema,
 } from '../responses';
 import { Schema } from 'joi';
 
@@ -74,6 +75,7 @@ export class CarrierApp implements ConnectRuntimeApp {
         definition.CreateManifest,
         CreateManifestResponseSchema,
       ],
+      [Method.POST, ApiEndpoints.GetManifest, definition.GetManifest, CreateManifestResponseSchema],
       [
         Method.POST,
         ApiEndpoints.CreateNotification,
@@ -102,6 +104,12 @@ export class CarrierApp implements ConnectRuntimeApp {
         ValidateInboundDataResponseSchema,
       ],
       [Method.POST, ApiEndpoints.VoidLabels, definition.VoidLabels, VoidLabelsResponseSchema],
+      [
+        Method.POST,
+        ApiEndpoints.GetRelayPoints,
+        definition.GetRelayPoints,
+        GetRelayPointsResponseSchema,
+      ],
     ).forEach(([method, path, implementation, schema]) => {
       if (implementation) {
         this.routes.push({

package/src/app/constants.ts

@@ -4,6 +4,7 @@ export enum ApiEndpoints {
   VoidLabels = '/VoidLabels',
   GetRates = '/GetRates',
   CreateManifest = '/CreateManifest',
+  GetManifest = '/GetManifest',
   SchedulePickup = '/SchedulePickup',
   CancelPickup = '/CancelPickup',
   Track = '/Track',
@@ -11,4 +12,5 @@ export enum ApiEndpoints {
   CancelNotification = '/CancelNotification',
   ValidateInboundData = '/ValidateInboundData',
   NormalizeTrackingData = '/NormalizeTrackingData',
+  GetRelayPoints = '/RelayPoints',
 }

package/src/app/internal/metadata.ts

@@ -30,6 +30,10 @@ const mapFunctions = (app: CarrierAppDefinition): FunctionSpecification[] => {
     fns.push(fn('CreateManifest'));
   }
 
+  if (app.GetManifest) {
+    fns.push(fn('GetManifest'));
+  }
+
   if (app.SchedulePickup) {
     fns.push(fn('SchedulePickup'));
   }

package/src/models/index.ts

@@ -22,3 +22,4 @@ export * from './taxes';
 export * from './documents';
 export * from './time-window';
 export * from './inbound-content-types';
+export * from './relay-points';

package/src/models/manifest-status.ts

@@ -0,0 +1,11 @@
+import Joi from 'joi';
+
+/** @description Possible status values for Created Manifest */
+export enum ManifestStatus {
+  /** @description Unknown, The request is in process */
+  Unknown = 'unknown',
+  InProgress = 'in_progress',
+  Completed = 'completed',
+  Failed = 'failed',
+}
+export const ManifestStatusSchema = Joi.string().valid(...Object.values(ManifestStatus));

package/src/models/relay-points/index.ts

@@ -0,0 +1,2 @@
+export * from './relay-point';
+export * from './opening-times';

package/src/models/relay-points/opening-times.ts

@@ -0,0 +1,21 @@
+import Joi from 'joi';
+
+export class OpeningTimes {
+  monday!: string;
+  tuesday!: string;
+  wednesday!: string;
+  thursday!: string;
+  friday!: string;
+  saturday!: string;
+  sunday!: string;
+}
+
+export const OpeningTimesSchema = Joi.object({
+  monday: Joi.string().required().empty(),
+  tuesday: Joi.string().required().empty(),
+  wednesday: Joi.string().required().empty(),
+  thursday: Joi.string().required().empty(),
+  friday: Joi.string().required().empty(),
+  saturday: Joi.string().required().empty(),
+  sunday: Joi.string().required().empty(),
+});

package/src/models/relay-points/relay-point.ts

@@ -0,0 +1,31 @@
+import Joi from 'joi';
+import { OpeningTimes, OpeningTimesSchema } from './opening-times';
+
+/** @description Basic structure for a relay point */
+export class RelayPoint {
+  relay_point_id!: string;
+  company_name?: string;
+  address_line1!: string;
+  city_locality!: string;
+  state_province!: string;
+  postal_code!: string;
+  country_code!: string;
+  phone?: string;
+  long?: number;
+  lat?: number;
+  opening_times!: OpeningTimes;
+}
+
+export const RelayPointSchema = Joi.object({
+  relay_point_id: Joi.string().required(),
+  company_name: Joi.string().optional().empty(),
+  address_line1: Joi.string().required(),
+  city_locality: Joi.string().required(),
+  state_province: Joi.string().required(),
+  postal_code: Joi.string().required(),
+  country_code: Joi.string().required(),
+  phone: Joi.string().required(),
+  long: Joi.number().optional(),
+  lat: Joi.number().optional(),
+  opening_times: OpeningTimesSchema.required(),
+});

package/src/requests/create-label-request.ts

@@ -14,6 +14,7 @@ import {
   ShipTo,
   Document,
   TimeWindow,
+  RelayPoint,
 } from '../models';
 
 /** @description Basic structure for a request to create a label */
@@ -34,6 +35,7 @@ export class CreateLabelRequest extends BaseRequest {
   ship_to!: ShipTo;
   ship_from!: ShipFrom;
   pickup_location?: PudoLocation;
+  relay_points?: RelayPoint[];
   ship_from_display?: ShipFromDisplay;
   /** @description Whether the shipment requires next day shipping */
   next_day?: boolean;

package/src/requests/get-manifest-request.ts

@@ -0,0 +1,13 @@
+import { BaseRequest } from './base-request';
+
+/** @description Basic structure for a request to get previousely created manifests */
+export class GetManifestRequest extends BaseRequest {
+  // Identifier to retrieve manifest
+  manifest_request_id?: number;
+
+  // Data required to retrieve manifests
+  manifest_identifiers?: { [key: string]: any };
+
+  // Default false: Allow up to 5 checks to DHL before returning.
+  return_immediately?: boolean;
+}

package/src/requests/get-relay-points-request.ts

@@ -0,0 +1,7 @@
+import { BaseRequest } from './base-request';
+
+export class GetRelayPointsRequest extends BaseRequest {
+  service_code!: string;
+  postal_code!: string;
+  country_code!: string;
+}

package/src/requests/index.ts

@@ -1,6 +1,7 @@
 export * from './cancel-pickup-request';
 export * from './create-label-request';
 export * from './create-manifest-request';
+export * from './get-manifest-request';
 export * from './get-rates-request';
 export * from './register-request';
 export * from './schedule-pickup-request';
@@ -10,3 +11,4 @@ export * from './create-notification-request';
 export * from './cancel-notification-request';
 export * from './validate-inbound-data-request';
 export * from './normalize-tracking-data-request';
+export * from './get-relay-points-request';

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

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

package/src/responses/get-relay-points-response.ts

@@ -0,0 +1,12 @@
+import { BaseResponse, BaseResponseSchema } from './base-response';
+import { RelayPoint, RelayPointSchema } from '../models';
+import Joi from 'joi';
+
+/** @description Basic structure for a response to create a label */
+export class GetRelayPointsResponse extends BaseResponse {
+  relay_points!: RelayPoint[];
+}
+
+export const GetRelayPointsResponseSchema = BaseResponseSchema.keys({
+  relay_points: Joi.array().required().items(RelayPointSchema),
+});

package/src/responses/index.ts

@@ -11,3 +11,4 @@ export * from './cancel-notification-response';
 export * from './create-notification-response';
 export * from './validate-inbound-data-response';
 export * from './normalize-tracking-data-response';
+export * from './get-relay-points-response';