@shipengine/connect-carrier-api 4.16.5 → 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/dangerous-good/dangerous-goods-declaration.ts

@@ -0,0 +1,14 @@
+import { Signatory } from '../signatory';
+import { DangerousGoodsContact } from './dangerous-goods-contact';
+
+/** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
+export class DangerousGoodsDeclaration {
+  /** @description Name of the regulatory authority */
+  regulation_set?: string;
+  /** @description Contact information for Dangerous goods */
+  emergency_contact?: DangerousGoodsContact;
+  /** @description An object containing details of the person signing the dangerous goods declaration. */
+  signatory?: Signatory;
+  /** @description Any supplementary instructions or special provisions related to the handling of the dangerous goods shipment, such as competent authority approvals or specific handling requirements. */
+  additional_handling_information?: string;
+}

package/src/models/dangerous-good/dangerous-goods-inner-packaging.ts

@@ -0,0 +1,7 @@
+/** @description An object detailing the inner packaging of the dangerous good. */
+export class DangerousGoodsInnerPackaging {
+  /** @description The type of inner packaging used (e.g., "Glass Bottle", "Plastic Jar", "Metal Can"). */
+  type?: string;
+  /** @description The number of individual inner packagings contained within the outer package for this specific dangerous good. */
+  quantity?: number;
+}

package/src/models/dangerous-good/dangerous-goods-package-info.ts

@@ -0,0 +1,20 @@
+import { RegulationLevelTypes } from './regulation-level-types';
+import { TransportMeanTypes } from './transport-mean-types';
+
+/** @description An object containing information specific to the dangerous goods aspects of an individual package. */
+export class DangerousGoodsPackageInfo {
+  /** @description Transportation means through which the dangerous goods are transported */
+  transport_mean?: TransportMeanTypes;
+  /** @description  Indicates whether the dangerous goods package must be accessible during transit for inspection or handling. true if accessible, false otherwise. */
+  accessibility?: boolean;
+  /** @description Specifies if the package is an overpack, meaning it contains one or more packages prepared in accordance with dangerous goods regulations. true if it is an overpack, false otherwise. */
+  is_overpack?: boolean;
+  /** @description Indicates whether all dangerous goods in the package are packed in accordance with the same regulations. True if all packed in one, false otherwise. */
+  all_packed_in_one?: boolean;
+  /** @description  The "Q" value, a calculated value used in certain dangerous goods regulations (e.g., IATA) to determine if a package is compliant with quantity limits in mixed packing scenarios. Can be null if not applicable. */
+  q_value?: number;
+  /** @description The type of outer packaging used for the dangerous goods package, typically represented by a UN packaging code (e.g., "4G" for fiberboard box, "1A2" for steel drum). */
+  outer_packaging_type?: string;
+  /** @description Regulation level of the dangerous goods */
+  regulation_level?: RegulationLevelTypes;
+}

package/src/models/dangerous-good/dangerous-goods.ts

@@ -4,6 +4,7 @@ import { RegulationLevelTypes } from './regulation-level-types';
 import { TransportMeanTypes } from './transport-mean-types';
 import { DangerousAmountDetails } from './weight-details';
 import { AccessibilityTypes } from '../accessibility-types';
+import { DangerousGoodsInnerPackaging } from './dangerous-goods-inner-packaging';
 
 /** @description Basic structure for a dangerous goods */
 export class DangerousGoods {
@@ -47,4 +48,8 @@ export class DangerousGoods {
   additional_description?: string;
   /** @description Identifies whatever the product being shipped is accessible or inaccessible during delivery.*/
   accessibility?: AccessibilityTypes;
+  /** @description A comma-separated list of special provisions (e.g., "A88, A183") that apply to the specific dangerous good as defined by the relevant dangerous goods regulations. These provisions may modify or clarify the general requirements. */
+  special_provisions?: string;
+  /** @description An object detailing the inner packaging of the dangerous good. */
+  inner_packaging?: DangerousGoodsInnerPackaging;
 }

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/package.ts

@@ -4,6 +4,7 @@ import { Currency } from './currency';
 import { LabelMessage } from './labels/label-message';
 import { Customs } from './customs';
 import { Products } from './products';
+import { DangerousGoodsPackageInfo } from './dangerous-good/dangerous-goods-package-info';
 
 /** @description Basic structure for a package */
 export class Package {
@@ -23,4 +24,6 @@ export class Package {
   customs?: Customs;
   /** @description List of products goods model associated with this package passed to the carrier. */
   products?: Products[];
+  /** @description An object containing information specific to the dangerous goods aspects of an individual package. */
+  dangerous_goods_package_info?: DangerousGoodsPackageInfo;
 }

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/create-label-request.ts

@@ -19,6 +19,7 @@ import {
   Customs,
   BillTo,
 } from '../models';
+import { DangerousGoodsDeclaration } from '../models/dangerous-good/dangerous-goods-declaration';
 
 /** @description Basic structure for a request to create a label */
 export class CreateLabelRequest extends BaseRequest {
@@ -58,4 +59,6 @@ export class CreateLabelRequest extends BaseRequest {
   customs?: Customs;
   /** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */
   bill_shipping_to?: BillTo;
+  /** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
+  dangerous_goods_declaration?: DangerousGoodsDeclaration;
 }

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

@@ -14,6 +14,7 @@ import {
   DisplayScheme,
 } from '../models';
 import { ShipmentItem } from '../models/shipment-item';
+import { DangerousGoodsDeclaration } from '../models/dangerous-good/dangerous-goods-declaration';
 
 /** @description Basic structure for a request to get rates */
 export class GetRatesRequest extends BaseRequest {
@@ -39,4 +40,6 @@ export class GetRatesRequest extends BaseRequest {
   bill_shipping_to?: BillTo;
   /** @description Display schemes in which the rate will be evaluated. Labels are used by default. */
   display_schemes?: DisplayScheme[];
+  /** @description An object containing high-level information about the dangerous goods declaration for the entire shipment. */
+  dangerous_goods_declaration?: DangerousGoodsDeclaration;
 }

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[];
+}