@shipengine/connect-carrier-api 4.29.2 → 4.31.0-beta

package/src/app/metadata/shipping-service.ts

@@ -11,6 +11,11 @@ import {
 import Joi from 'joi';
 
 import { ApiCodeRegex, ApiCodeValidationMessage } from '@shipengine/connect-runtime';
+import { Transit, TransitSchema } from './transit';
+import { PackageConstraints, PackageConstraintsSchema } from './package-constraints';
+import { ServiceDirection } from './enums';
+
+const ServiceDirectionSchema = Joi.string().valid(...Object.values(ServiceDirection));
 
 /** @description Basic structure for each shipping service */
 export interface ShippingService {
@@ -42,6 +47,16 @@ export interface ShippingService {
   ApiCode?: string;
   /** @description The unique identifier for this shipping service. It should not change after being published */
   Id: string;
+  /** @description Customer-facing description of service capabilities and features */
+  ServiceDescription?: string;
+  /** @description Direction of this service */
+  ServiceDirection?: ServiceDirection;
+  /** @description List of ISO 3166-1 alpha-2 destination country codes supported by this service */
+  DestinationCountries?: string[];
+  /** @description Transit time and delivery schedule information */
+  Transit?: Transit;
+  /** @description Package size and weight constraints for this service */
+  PackageConstraints?: PackageConstraints;
 }
 
 export const ShippingServiceSchema = Joi.object({
@@ -59,4 +74,12 @@ export const ShippingServiceSchema = Joi.object({
   Name: Joi.string().required().max(80),
   ApiCode: Joi.string().optional().pattern(ApiCodeRegex, ApiCodeValidationMessage),
   Id: Joi.string().uuid().required(),
+  ServiceDescription: Joi.string().optional(),
+  ServiceDirection: ServiceDirectionSchema.optional(),
+  DestinationCountries: Joi.array()
+    .optional()
+    .items(Joi.string().pattern(/^[A-Z]{2}$/))
+    .unique(),
+  Transit: TransitSchema.optional(),
+  PackageConstraints: PackageConstraintsSchema.optional(),
 });

package/src/app/metadata/transit.ts

@@ -0,0 +1,36 @@
+import Joi from 'joi';
+import { DayOfWeek } from './enums';
+
+/** @description Operational schedule defining collection, trunking and delivery days */
+export interface OperationalSchedule {
+  /** @description Days on which the carrier collects parcels */
+  CollectionDays?: DayOfWeek[];
+  /** @description Days on which the carrier trunks parcels between hubs */
+  TrunkingDays?: DayOfWeek[];
+  /** @description Days on which the carrier delivers parcels */
+  DeliveryDays?: DayOfWeek[];
+}
+
+const DayOfWeekSchema = Joi.string().valid(...Object.values(DayOfWeek));
+
+export const OperationalScheduleSchema = Joi.object({
+  CollectionDays: Joi.array().optional().items(DayOfWeekSchema).unique(),
+  TrunkingDays: Joi.array().optional().items(DayOfWeekSchema).unique(),
+  DeliveryDays: Joi.array().optional().items(DayOfWeekSchema).unique(),
+});
+
+/** @description Transit information for a shipping service */
+export interface Transit {
+  /** @description Transit time in days, as a number or range (e.g. "3" or "3-5") */
+  TransitTimeInDays?: string | null;
+  /** @description Latest time of day by which delivery is made (e.g. "17:00") */
+  DeliveryByTime?: string | null;
+  /** @description Operational schedule for collection, trunking and delivery days */
+  OperationalSchedule?: OperationalSchedule;
+}
+
+export const TransitSchema = Joi.object({
+  TransitTimeInDays: Joi.string().optional().allow(null),
+  DeliveryByTime: Joi.string().optional().allow(null),
+  OperationalSchedule: OperationalScheduleSchema.optional(),
+});

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

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

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

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

package/src/models/cpsc-disclaim.ts

@@ -0,0 +1,11 @@
+import { CpscDisclaimCode } from './cpsc-disclaim-code';
+
+/** @description CPSC (U.S. Consumer Product Safety Commission) eFiling Disclaim data for products that are not subject to CPSC regulation. */
+export class CpscDisclaim {
+  /** @description The disclaim code indicating the reason a product is exempt from CPSC regulation. */
+  disclaim_code?: CpscDisclaimCode;
+  /** @description A code identifying the intended use of the product. Maximum length of 16 characters. */
+  intended_use_code?: string;
+  /** @description A description of the intended use of the product. Maximum length of 100 characters. */
+  intended_use_description?: string;
+}

package/src/models/index.ts

@@ -7,6 +7,9 @@ export * from './billing';
 export * from './confirmation-types';
 export * from './cpsc-certificate';
 export * from './cpsc-certificate-schema';
+export * from './cpsc-disclaim';
+export * from './cpsc-disclaim-code';
+export * from './cpsc-disclaim-schema';
 export * from './currency-schema';
 export * from './currency';
 export * from './customs';

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

@@ -3,6 +3,7 @@ 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 { CpscDisclaimSchema } from '../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

@@ -2,6 +2,7 @@ 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 { CpscDisclaim } from '../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

@@ -4,6 +4,7 @@ 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 { CpscDisclaim } from './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;
 }