@shipengine/connect-carrier-api 4.16.6 → 4.16.7

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

@@ -19,6 +19,7 @@ import {
   GetServicePointRequest,
   ImportTrackingEventsRequest,
   UpdateSettingsRequest,
+  ListPickupsRequest,
 } from '../requests';
 
 import {
@@ -38,6 +39,7 @@ import {
   GetServicePointsResponse,
   GetServicePointResponse,
   UpdateSettingsResponse,
+  ListPickupsResponse,
 } from '../responses';
 
 import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
@@ -158,6 +160,11 @@ export interface CarrierAppDefinition {
   ImportTrackingEvents?: (
     request: ImportTrackingEventsRequest,
   ) => AsyncGenerator<ImportedTrackingEvent>;
+  /**
+   * @description This endpoint is used to list information about previously scheduled pickups
+   * @param request Data needed by the provider to list pickups
+   */
+  ListPickups?: (request: ListPickupsRequest) => ListPickupsResponse | Promise<ListPickupsResponse>;
 
   ScheduledFunction?: (request: Record<string, any>) => Promise<{}[] | null> | {}[] | null;
 

package/src/app/constants.ts

@@ -17,4 +17,5 @@ export enum ApiEndpoints {
   GetServicePoint = '/GetServicePoint',
   ImportTrackingEvents = '/ImportTrackingEvents',
   UpdateSettings = '/UpdateSettings',
+  ListPickups = '/ListPickups',
 }

package/src/app/create-endpoint-mapping.ts

@@ -25,5 +25,6 @@ export const createEndpointMapping = (
   [Method.POST, ApiEndpoints.GetServicePoint, definition.GetServicePoint],
   [Method.POST, ApiEndpoints.ImportTrackingEvents, definition.ImportTrackingEvents],
   [Method.POST, ApiEndpoints.UpdateSettings, definition.UpdateSettings],
+  [Method.POST, ApiEndpoints.ListPickups, definition.ListPickups],
   ...mapExtensions(definition.Extensions),
 ];

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

@@ -0,0 +1,3 @@
+import { AddressBase } from './address-base';
+
+export class PickupAddress extends AddressBase {}

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

@@ -7,6 +7,4 @@ export class VoidRequest extends ShippedShipment {
   void_request_id!: string;
   /** @description The location the shipment was shipped from */
   ship_from!: ShipFrom;
-  /** @description The shipment's user provided reference */
-  reference?: string;
 }

package/src/models/manifests/manifest-request-shipment.ts

@@ -4,6 +4,5 @@ import { ManifestCustoms } from './manifest-customs';
 export class ManifestRequestShipment extends ShippedShipment {
   manifest_request_shipment_id!: string;
   ship_datetime?: string;
-  reference?: string;
   customs?: ManifestCustoms;
 }

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

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+
+export const PickupSchema = Joi.object({
+  confirmation_number: Joi.string().required(),
+  status: Joi.string().required(),
+  status_reason: Joi.string().optional(),
+});

package/src/models/pickup/pickup.ts

@@ -0,0 +1,5 @@
+export class Pickup {
+  confirmation_number!: string;
+  status!: string;
+  status_reason?: string;
+}

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

@@ -21,6 +21,8 @@ export class ShippedShipment extends Label {
   pickup_location?: PudoLocation;
   /** @description Add drop-off location detail*/
   dropoff_location?: PudoLocation;
+  /** @description User specified free form string to identify shipment in their own system */
+  reference?: string;
 }
 
 export class PickupShipment extends ShippedShipment {}

package/src/models/tracking/index.ts

@@ -14,3 +14,5 @@ export * from './tracking-info-schema';
 export * from './tracking-info';
 export * from './update-method-schema';
 export * from './update-method';
+export * from './standardized-status-detail-codes';
+export * from './standardized-status-detail-codes-schema';

package/src/requests/index.ts

@@ -12,6 +12,7 @@ export * from './import-tracking-events-request';
 export * from './normalize-tracking-data-request';
 export * from './register-request';
 export * from './schedule-pickup-request';
+export * from './list-pickups-request';
 export * from './tracking-request';
 export * from './validate-inbound-data-request';
 export * from './void-labels-request';

package/src/requests/list-pickups-request.ts

@@ -0,0 +1,10 @@
+import { PickupAddress } from '../models/addresses/pickup-address';
+import { TimeWindow } from '../models/time-window';
+import { BaseRequest } from './base-request';
+
+/** @description Basic structure for a request to list scheduled pickups */
+export class ListPickupsRequest extends BaseRequest {
+  /** @description The address to search for scheduled pickups. */
+  address?: PickupAddress;
+  search_window?: TimeWindow;
+}

package/src/responses/index.ts

@@ -23,6 +23,8 @@ export * from './register-response-schema';
 export * from './register-response';
 export * from './schedule-pickup-response-schema';
 export * from './schedule-pickup-response';
+export * from './list-pickups-response-schema';
+export * from './list-pickups-response';
 export * from './tracking-response-schema';
 export * from './tracking-response';
 export * from './validate-inbound-data-response-schema';

package/src/responses/list-pickups-response-schema.ts

@@ -0,0 +1,6 @@
+import { BaseResponseSchema } from './base-response-schema';
+import { PickupSchema } from '../models/pickup/pickup-schema';
+
+export const ListPickupsResponseSchema = BaseResponseSchema.keys({
+  pickups: PickupSchema.required(),
+});

package/src/responses/list-pickups-response.ts

@@ -0,0 +1,7 @@
+import { Pickup } from '../models/pickup/pickup';
+import { BaseResponse } from './base-response';
+
+/** @description Basic structure for a response to list scheduled pickups */
+export class ListPickupsResponse extends BaseResponse {
+  pickups!: Pickup[];
+}