@shipengine/connect-carrier-api 4.32.0 → 4.34.0

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

@@ -7,6 +7,7 @@ export const createEndpointMapping = (
 ): [Method, string, Handler | undefined][] => [
   //TODO: Remove `Method.POST` from this and all other maps since they are ALL post
   //TODO: Remove JOI validation from all endpoints and replace them with OpenAPI validation
+  [Method.POST, ApiEndpoints.BulkTrack, definition.BulkTrack],
   [Method.POST, ApiEndpoints.CancelNotification, definition.CancelNotification],
   [Method.POST, ApiEndpoints.CancelPickup, definition.CancelPickup],
   [Method.POST, ApiEndpoints.CreateLabel, definition.CreateLabel],

package/src/models/cpsc/cpsc-disclaim-schema.ts

@@ -0,0 +1,10 @@
+import Joi from 'joi';
+import { DisclaimCode } from './disclaim-code';
+
+export const CpscDisclaimSchema = Joi.object({
+  disclaim_code: Joi.string()
+    .valid(...Object.values(DisclaimCode))
+    .optional(),
+  intended_use_code: Joi.string().max(16).optional(),
+  intended_use_description: Joi.string().max(100).optional(),
+});

package/src/models/cpsc/cpsc-disclaim.ts

@@ -0,0 +1,11 @@
+import { DisclaimCode } from './disclaim-code';
+
+/** @description Object for CPSC disclaimer data, submitted when the shipment qualifies for a disclaim message instead of a full CPSC certificate of compliance. Note: Omit this object if the product requires CPSC certification. */
+export class CpscDisclaim {
+  /** @description Code representing the CPSC declaration status. Accepted values: "A" - Product is not regulated by CPSC. "B" - Data is not required per CPSC. */
+  disclaim_code?: DisclaimCode;
+  /** @description A code from CBP's Intended Use Code list indicating the product's intended use. Must be submitted alongside any disclaim message. */
+  intended_use_code?: string;
+  /** @description Description of the product's intended use. If "For Other Use" (980.000) code is used, then a free text description of the intended use should be provided. */
+  intended_use_description?: string;
+}

package/src/models/cpsc/disclaim-code.ts

@@ -0,0 +1,4 @@
+export enum DisclaimCode {
+  A = 'A',
+  B = 'B',
+}

package/src/models/cpsc/index.ts

@@ -0,0 +1,5 @@
+export * from './cpsc-certificate';
+export * from './cpsc-certificate-schema';
+export * from './cpsc-disclaim';
+export * from './cpsc-disclaim-schema';
+export * from './disclaim-code';

package/src/models/index.ts

@@ -5,8 +5,7 @@ export * from './cod-payment-type';
 export * from './collect-on-delivery';
 export * from './billing';
 export * from './confirmation-types';
-export * from './cpsc-certificate';
-export * from './cpsc-certificate-schema';
+export * from './cpsc';
 export * from './currency-schema';
 export * from './currency';
 export * from './customs';

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

@@ -2,7 +2,8 @@ import Joi from 'joi';
 import { CurrencySchema } from '@shipengine/connect-carrier-api';
 import { WeightDetailsSchema } from '../units/weight-details-schema';
 import { ManufacturerProductIdentifierType } from '../manufacturer-product-identifier-type';
-import { CpscCertificateSchema } from '../cpsc-certificate-schema';
+import { CpscCertificateSchema } from '../cpsc/cpsc-certificate-schema';
+import { CpscDisclaimSchema } from '../cpsc/cpsc-disclaim-schema';
 
 export const ShippedProductsSchema = Joi.object({
   description: Joi.string().optional(),
@@ -23,4 +24,5 @@ export const ShippedProductsSchema = Joi.object({
   manufacturer_ns_product_id: Joi.string().optional(),
   dangerous_goods: Joi.object().optional(),
   cpsc_certificates: Joi.array().items(CpscCertificateSchema).optional(),
+  cpsc_disclaim: CpscDisclaimSchema.optional(),
 });

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

@@ -1,7 +1,8 @@
 import { Currency, WeightDetails } from '@shipengine/connect-carrier-api';
 import { DangerousGoods } from '../dangerous-good/dangerous-goods';
 import { ManufacturerProductIdentifierType } from '../manufacturer-product-identifier-type';
-import { CpscCertificate } from '../cpsc-certificate';
+import { CpscCertificate } from '../cpsc/cpsc-certificate';
+import { CpscDisclaim } from '../cpsc/cpsc-disclaim';
 
 /** @description Basic structure for a product from a shipped shipment*/
 export class ShippedProducts {
@@ -37,6 +38,8 @@ export class ShippedProducts {
   dangerous_goods?: DangerousGoods[];
   /** @description CPSC (U.S. Consumer Product Safety Commission) Certificate of Compliance reference data for U.S. CPSC eFiling. Supports the Reference (Abbreviated) PGA Message Set. */
   cpsc_certificates?: CpscCertificate[];
+  /** @description CPSC (U.S. Consumer Product Safety Commission) eFiling Disclaim data for products that are not subject to CPSC regulation. */
+  cpsc_disclaim?: CpscDisclaim;
   /** @description Additional details for product. */
   [key: string]: any;
 }

package/src/models/products.ts

@@ -3,7 +3,8 @@ import { Currency } from './currency';
 import { DangerousGoods } from './dangerous-good/dangerous-goods';
 import { UnitOfMeasureTypes } from './customs/unit-of-measure-types';
 import { ManufacturerProductIdentifierType } from './manufacturer-product-identifier-type';
-import { CpscCertificate } from './cpsc-certificate';
+import { CpscCertificate } from './cpsc/cpsc-certificate';
+import { CpscDisclaim } from './cpsc/cpsc-disclaim';
 
 /** @description Basic structure for a product */
 export class Products {
@@ -41,6 +42,8 @@ export class Products {
   manufacturer_ns_product_id?: string;
   /** @description CPSC (U.S. Consumer Product Safety Commission) Certificate of Compliance reference data for U.S. CPSC eFiling. Supports the Reference (Abbreviated) PGA Message Set. */
   cpsc_certificates?: CpscCertificate[];
+  /** @description CPSC (U.S. Consumer Product Safety Commission) eFiling Disclaim data for products that are not subject to CPSC regulation. */
+  cpsc_disclaim?: CpscDisclaim;
   /** @description Additional details for product. */
   [key: string]: any;
 }

package/src/models/tracking/bulk-tracking-error.ts

@@ -0,0 +1,7 @@
+/** @description Error detail for a single item within a bulk tracking response */
+export class BulkTrackingError {
+  /** @description A code identifying the type of error encountered while tracking this item */
+  code!: string;
+  /** @description A human readable description of the error */
+  message!: string;
+}

package/src/models/tracking/index.ts

@@ -1,3 +1,4 @@
+export * from './bulk-tracking-error';
 export * from './imported-tracking-event-schema';
 export * from './imported-tracking-event';
 export * from './lat-long-schema';

package/src/requests/bulk-tracking-request.ts

@@ -0,0 +1,16 @@
+import { BaseRequest } from './base-request';
+import { TrackingIdentifier, TrackingAttribute } from '../models';
+
+/** @description A single shipment to request tracking information for as part of a bulk tracking request */
+export class BulkTrackingItem {
+  /** @description List of identifiers */
+  identifiers?: TrackingIdentifier[];
+  /** @description List of attributes */
+  attributes?: TrackingAttribute[];
+}
+
+/** @description Basic structure for a request to get tracking information for multiple shipments in a single call */
+export class BulkTrackingRequest extends BaseRequest {
+  /** @description The shipments to retrieve tracking information for */
+  items!: BulkTrackingItem[];
+}

package/src/requests/index.ts

@@ -1,3 +1,4 @@
+export * from './bulk-tracking-request';
 export * from './cancel-notification-request';
 export * from './cancel-pickup-request';
 export * from './create-label-request';

package/src/responses/bulk-tracking-response.ts

@@ -0,0 +1,20 @@
+import { BaseResponse } from './base-response';
+import { TrackingInfo } from '../models';
+import { BulkTrackingError } from '../models/tracking/bulk-tracking-error';
+
+/** @description Tracking result for a single item within a bulk tracking response */
+export class BulkTrackingResultItem {
+  /** @description The carrier specific tracking identifier for this shipment */
+  tracking_number!: string;
+  /** @description Tracking information for this shipment, present when tracking succeeded */
+  tracking_info?: TrackingInfo;
+  /** @description Error detail for this shipment, present when tracking failed */
+  error?: BulkTrackingError;
+}
+
+/** @description Basic structure for a response to get tracking information for multiple shipments in a single call */
+export class BulkTrackingResponse extends BaseResponse {
+  transaction_id!: string;
+  /** @description Per-item tracking results, in no guaranteed order relative to the request's items */
+  results!: BulkTrackingResultItem[];
+}

package/src/responses/index.ts

@@ -1,3 +1,4 @@
+export * from './bulk-tracking-response';
 export * from './cancel-notification-response-schema';
 export * from './cancel-notification-response';
 export * from './cancel-pickup-response-schema';