@shipengine/connect-carrier-api 4.16.8-beta.1 → 4.16.8-beta.3

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

@@ -1,54 +1,54 @@
-import Joi from 'joi';
-
-export interface ShippingOption {
-  Name: string;
-  Type: ShippingOptionEnum;
-  Description: string;
-}
-
-export type ShippingOptionDescription = { Name: string; Description: string };
-export type ShippingOptionDictionary = {
-  [Key in ShippingOptionEnum]?: ShippingOptionDescription;
-};
-export const ShippingOptionDescriptionSchema = Joi.object({
-  Name: Joi.string().required().max(50),
-  Description: Joi.string().required().max(255),
-}).optional();
-
-export enum ShippingOptionEnum {
-  ContainsAlcohol = 'alcohol',
-  B13ACanada = 'b13a-canada',
-  BillToSender = 'bill-to-sender',
-  BillToThirdParty = 'bill-to-third-party',
-  CollectOnDelivery = 'collect-on-delivery',
-  ConsequentialLoss = 'consequential-loss',
-  DangerousGoods = 'dangerous-goods',
-  DeliveryMessage = 'delivery-message',
-  DontPrepayPostage = 'dont-prepay-postage',
-  DryIce = 'dry-ice',
-  EmailNotification = 'email-notification',
-  FreightClass = 'freight-class',
-  HoldForPickup = 'hold-for-pickup',
-  IncludeReturnLabel = 'include-return-label',
-  LocalCollect = 'local-collect',
-  NonMachinable = 'non-machinable',
-  NotificationType = 'notification-type',
-  ReleaseNoSignature = 'shipper-release',
-  RequiresAdditionalHandling = 'additional-handling',
-  Safeplace = 'safeplace',
-  SaturdayDelivery = 'saturday-delivery',
-  SaturdayGuarantee = 'saturday-guarantee',
-  SmsNotification = 'sms-notification',
-  SpecialHandling = 'special-handling',
-  ThirdPartyConsignee = 'third-party-consignee',
-  CarrierInsurance = 'carrier-insurance',
-  WindsorFrameworkMovementIndicator = 'windsor-framework-movement-indicator',
-  WindsorFrameworkNotAtRisk = 'windsor-framework-not-at-risk',
-}
-
-export const ShippingOptionDictionarySchema = Joi.object(
-  Object.values(ShippingOptionEnum).reduce((accumulator: any, option) => {
-    accumulator[option] = ShippingOptionDescriptionSchema;
-    return accumulator;
-  }, {}),
-);
+import Joi from 'joi';
+
+export interface ShippingOption {
+  Name: string;
+  Type: ShippingOptionEnum;
+  Description: string;
+}
+
+export type ShippingOptionDescription = { Name: string; Description: string };
+export type ShippingOptionDictionary = {
+  [Key in ShippingOptionEnum]?: ShippingOptionDescription;
+};
+export const ShippingOptionDescriptionSchema = Joi.object({
+  Name: Joi.string().required().max(50),
+  Description: Joi.string().required().max(255),
+}).optional();
+
+export enum ShippingOptionEnum {
+  ContainsAlcohol = 'alcohol',
+  B13ACanada = 'b13a-canada',
+  BillToSender = 'bill-to-sender',
+  BillToThirdParty = 'bill-to-third-party',
+  CollectOnDelivery = 'collect-on-delivery',
+  ConsequentialLoss = 'consequential-loss',
+  DangerousGoods = 'dangerous-goods',
+  DeliveryMessage = 'delivery-message',
+  DontPrepayPostage = 'dont-prepay-postage',
+  DryIce = 'dry-ice',
+  EmailNotification = 'email-notification',
+  FreightClass = 'freight-class',
+  HoldForPickup = 'hold-for-pickup',
+  IncludeReturnLabel = 'include-return-label',
+  LocalCollect = 'local-collect',
+  NonMachinable = 'non-machinable',
+  NotificationType = 'notification-type',
+  ReleaseNoSignature = 'shipper-release',
+  RequiresAdditionalHandling = 'additional-handling',
+  Safeplace = 'safeplace',
+  SaturdayDelivery = 'saturday-delivery',
+  SaturdayGuarantee = 'saturday-guarantee',
+  SmsNotification = 'sms-notification',
+  SpecialHandling = 'special-handling',
+  ThirdPartyConsignee = 'third-party-consignee',
+  CarrierInsurance = 'carrier-insurance',
+  WindsorFrameworkMovementIndicator = 'windsor-framework-movement-indicator',
+  WindsorFrameworkNotAtRisk = 'windsor-framework-not-at-risk',
+}
+
+export const ShippingOptionDictionarySchema = Joi.object(
+  Object.values(ShippingOptionEnum).reduce((accumulator: any, option) => {
+    accumulator[option] = ShippingOptionDescriptionSchema;
+    return accumulator;
+  }, {}),
+);

package/src/app/metadata/shipping-provider-connector.ts

@@ -1,8 +1,8 @@
-import { FunctionSpecification } from './function';
-import DiagnosticRoutes from './diagnostic-routes';
-
-export interface ShippingProviderConnector {
-  Functions: FunctionSpecification[];
-  ApiVersion: string;
-  DiagnosticRoutes?: DiagnosticRoutes;
-}
+import { FunctionSpecification } from './function';
+import DiagnosticRoutes from './diagnostic-routes';
+
+export interface ShippingProviderConnector {
+  Functions: FunctionSpecification[];
+  ApiVersion: string;
+  DiagnosticRoutes?: DiagnosticRoutes;
+}

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

@@ -1,62 +1,62 @@
-import { ConfirmationType, ConfirmationTypeSchema } from './confirmation-type';
-import { CountryAssociation, CountryAssociationSchema } from './country-association';
-import { ServiceAttributesEnum, ServiceAttributesEnumSchema } from './services-attributes';
-import { LabelSizesEnum, LabelSizesEnumSchema } from './label-sizes';
-import { ServiceClassEnum, ServiceClassEnumSchema } from './service-class';
-import { ServiceGradeEnum, ServiceGradeEnumSchema } from './service-grade';
-import {
-  ServiceRequiredPropertiesEnum,
-  ServiceRequiredPropertiesEnumSchema,
-} from './service-required-properties';
-import Joi from 'joi';
-
-import { ApiCodeRegex, ApiCodeValidationMessage } from '@shipengine/connect-runtime';
-
-/** @description Basic structure for each shipping service */
-export interface ShippingService {
-  /** @description The confirmation types associated with this service */
-  ConfirmationTypes?: ConfirmationType[];
-  /** @description A list of attributes about this service */
-  ServiceAttributes?: ServiceAttributesEnum[];
-  /** @description A list of countries supported by this service */
-  SupportedCountries?: CountryAssociation[];
-  /** @description A list of label sizes supported by this service */
-  SupportedLabelSizes?: LabelSizesEnum[];
-  /** @description */
-  RequiredProperties?: ServiceRequiredPropertiesEnum[];
-  /** @description The grade of the service. ex: Economy, Expedited, Overnight */
-  Grade?: ServiceGradeEnum;
-  /** @description The class of service. ex: Ground, OneDay, ThreeDay */
-  Class?: ServiceClassEnum;
-  /** @description The label code associated with this shipping service */
-  LabelCode?: string;
-  /** @description Indicates whether or not this service is for international or domestic use */
-  International?: boolean;
-  /** @description This is the code that will be sent to requests, this should be the same code the carrier's api would expect */
-  Code: string;
-  /** @description This is an abbreviation of the name, can match the name if it is short enough */
-  Abbreviation: string;
-  /** @description The name of this shipping service ex: 'Overnight Guarantee' */
-  Name: string;
-  /** @description The identifier for this shipping service to be used in API calls. Must be snake cased and unique */
-  ApiCode?: string;
-  /** @description The unique identifier for this shipping service. It should not change after being published */
-  Id: string;
-}
-
-export const ShippingServiceSchema = Joi.object({
-  ConfirmationTypes: Joi.array().optional().items(ConfirmationTypeSchema).unique('Type'),
-  ServiceAttributes: Joi.array().items(ServiceAttributesEnumSchema).optional(),
-  SupportedCountries: Joi.array().optional().items(CountryAssociationSchema).unique('FromCountry'),
-  SupportedLabelSizes: Joi.array().optional().items(LabelSizesEnumSchema).unique(),
-  RequiredProperties: Joi.array().optional().items(ServiceRequiredPropertiesEnumSchema).unique(),
-  Grade: ServiceGradeEnumSchema.optional(),
-  Class: ServiceClassEnumSchema.optional(),
-  LabelCode: Joi.string().optional().max(50),
-  International: Joi.boolean().strict().optional(),
-  Code: Joi.string().required().max(50),
-  Abbreviation: Joi.string().required().max(20),
-  Name: Joi.string().required().max(80),
-  ApiCode: Joi.string().optional().pattern(ApiCodeRegex, ApiCodeValidationMessage),
-  Id: Joi.string().uuid().required(),
-});
+import { ConfirmationType, ConfirmationTypeSchema } from './confirmation-type';
+import { CountryAssociation, CountryAssociationSchema } from './country-association';
+import { ServiceAttributesEnum, ServiceAttributesEnumSchema } from './services-attributes';
+import { LabelSizesEnum, LabelSizesEnumSchema } from './label-sizes';
+import { ServiceClassEnum, ServiceClassEnumSchema } from './service-class';
+import { ServiceGradeEnum, ServiceGradeEnumSchema } from './service-grade';
+import {
+  ServiceRequiredPropertiesEnum,
+  ServiceRequiredPropertiesEnumSchema,
+} from './service-required-properties';
+import Joi from 'joi';
+
+import { ApiCodeRegex, ApiCodeValidationMessage } from '@shipengine/connect-runtime';
+
+/** @description Basic structure for each shipping service */
+export interface ShippingService {
+  /** @description The confirmation types associated with this service */
+  ConfirmationTypes?: ConfirmationType[];
+  /** @description A list of attributes about this service */
+  ServiceAttributes?: ServiceAttributesEnum[];
+  /** @description A list of countries supported by this service */
+  SupportedCountries?: CountryAssociation[];
+  /** @description A list of label sizes supported by this service */
+  SupportedLabelSizes?: LabelSizesEnum[];
+  /** @description */
+  RequiredProperties?: ServiceRequiredPropertiesEnum[];
+  /** @description The grade of the service. ex: Economy, Expedited, Overnight */
+  Grade?: ServiceGradeEnum;
+  /** @description The class of service. ex: Ground, OneDay, ThreeDay */
+  Class?: ServiceClassEnum;
+  /** @description The label code associated with this shipping service */
+  LabelCode?: string;
+  /** @description Indicates whether or not this service is for international or domestic use */
+  International?: boolean;
+  /** @description This is the code that will be sent to requests, this should be the same code the carrier's api would expect */
+  Code: string;
+  /** @description This is an abbreviation of the name, can match the name if it is short enough */
+  Abbreviation: string;
+  /** @description The name of this shipping service ex: 'Overnight Guarantee' */
+  Name: string;
+  /** @description The identifier for this shipping service to be used in API calls. Must be snake cased and unique */
+  ApiCode?: string;
+  /** @description The unique identifier for this shipping service. It should not change after being published */
+  Id: string;
+}
+
+export const ShippingServiceSchema = Joi.object({
+  ConfirmationTypes: Joi.array().optional().items(ConfirmationTypeSchema).unique('Type'),
+  ServiceAttributes: Joi.array().items(ServiceAttributesEnumSchema).optional(),
+  SupportedCountries: Joi.array().optional().items(CountryAssociationSchema).unique('FromCountry'),
+  SupportedLabelSizes: Joi.array().optional().items(LabelSizesEnumSchema).unique(),
+  RequiredProperties: Joi.array().optional().items(ServiceRequiredPropertiesEnumSchema).unique(),
+  Grade: ServiceGradeEnumSchema.optional(),
+  Class: ServiceClassEnumSchema.optional(),
+  LabelCode: Joi.string().optional().max(50),
+  International: Joi.boolean().strict().optional(),
+  Code: Joi.string().required().max(50),
+  Abbreviation: Joi.string().required().max(20),
+  Name: Joi.string().required().max(80),
+  ApiCode: Joi.string().optional().pattern(ApiCodeRegex, ApiCodeValidationMessage),
+  Id: Joi.string().uuid().required(),
+});

package/src/app/metadata/zone.ts

@@ -1,18 +1,18 @@
-import Joi from 'joi';
-import { ApiCodeRegex, ApiCodeValidationMessage } from '@shipengine/connect-runtime';
-
-/** @description Basic details about a carrier zone */
-export interface Zone {
-  /** @description The name of this zone ex: '1' or 'EU-3' */
-  Name: string;
-  /** @description This is a human readable description about what the zone is */
-  Description?: string;
-  /** @description The identifier for this zone that could be used for rating keys. Must be snake cased and unique */
-  ApiCode: string;
-}
-
-export const ZoneSchema = Joi.object({
-  Name: Joi.string().required().max(50),
-  Description: Joi.string().optional().max(500),
-  ApiCode: Joi.string().required().pattern(ApiCodeRegex, ApiCodeValidationMessage),
-});
+import Joi from 'joi';
+import { ApiCodeRegex, ApiCodeValidationMessage } from '@shipengine/connect-runtime';
+
+/** @description Basic details about a carrier zone */
+export interface Zone {
+  /** @description The name of this zone ex: '1' or 'EU-3' */
+  Name: string;
+  /** @description This is a human readable description about what the zone is */
+  Description?: string;
+  /** @description The identifier for this zone that could be used for rating keys. Must be snake cased and unique */
+  ApiCode: string;
+}
+
+export const ZoneSchema = Joi.object({
+  Name: Joi.string().required().max(50),
+  Description: Joi.string().optional().max(500),
+  ApiCode: Joi.string().required().pattern(ApiCodeRegex, ApiCodeValidationMessage),
+});

package/src/app/native-rating-data-validator.ts

@@ -1,61 +1,61 @@
-import { resolve } from 'path';
-import { existsSync, readFileSync } from 'fs';
-import { Carrier } from './metadata/carrier';
-
-interface DataValidationError {
-  message?: string;
-  duplicateKeys?: string[];
-}
-
-const getDuplicateKeys = (dataArray: { key: string }[]): string[] | undefined => {
-  let keys: string[] = [];
-  let keyContainer = Object.create(null);
-  dataArray.forEach((arrayItem) => {
-    if (arrayItem['key']) {
-      if (keyContainer[arrayItem['key']]) {
-        keys.push(arrayItem['key']);
-      } else {
-        keyContainer[arrayItem['key']] = true;
-      }
-    }
-  });
-
-  return keys.length > 0 ? keys : undefined;
-};
-
-const validate = (dataFilePath: string, dataType: string): DataValidationError | undefined => {
-  if (existsSync(dataFilePath)) {
-    const dataBuffer = readFileSync(dataFilePath);
-    const json = JSON.parse(dataBuffer.toString());
-    const data = json?.[dataType] || [];
-
-    const duplicates = getDuplicateKeys(data);
-    if (duplicates) {
-      return {
-        message: `${dataType} in ${dataFilePath} contains duplicate keys.`,
-        duplicateKeys: duplicates,
-      };
-    }
-  }
-};
-
-export const isDataValidationError = (
-  errors: DataValidationError[] | undefined,
-): errors is DataValidationError[] => errors !== undefined;
-
-export const validateRatingData = (carrier: Carrier): DataValidationError[] | undefined => {
-  let errors: DataValidationError[] = [];
-  let basePath = carrier.NativeRating?.Path ?? '';
-
-  let error = validate(resolve(basePath, 'zones.json'), 'zones');
-  if (error) errors.push(error);
-
-  carrier.NativeRating?.RateCards?.forEach((rateCard) => {
-    error = validate(resolve(basePath, rateCard.Id, 'rates.json'), 'rates');
-    if (error) errors.push(error);
-    error = validate(resolve(basePath, rateCard.Id, 'variables.json'), 'variables');
-    if (error) errors.push(error);
-  });
-
-  return errors.length > 0 ? errors : undefined;
-};
+import { resolve } from 'path';
+import { existsSync, readFileSync } from 'fs';
+import { Carrier } from './metadata/carrier';
+
+interface DataValidationError {
+  message?: string;
+  duplicateKeys?: string[];
+}
+
+const getDuplicateKeys = (dataArray: { key: string }[]): string[] | undefined => {
+  let keys: string[] = [];
+  let keyContainer = Object.create(null);
+  dataArray.forEach((arrayItem) => {
+    if (arrayItem['key']) {
+      if (keyContainer[arrayItem['key']]) {
+        keys.push(arrayItem['key']);
+      } else {
+        keyContainer[arrayItem['key']] = true;
+      }
+    }
+  });
+
+  return keys.length > 0 ? keys : undefined;
+};
+
+const validate = (dataFilePath: string, dataType: string): DataValidationError | undefined => {
+  if (existsSync(dataFilePath)) {
+    const dataBuffer = readFileSync(dataFilePath);
+    const json = JSON.parse(dataBuffer.toString());
+    const data = json?.[dataType] || [];
+
+    const duplicates = getDuplicateKeys(data);
+    if (duplicates) {
+      return {
+        message: `${dataType} in ${dataFilePath} contains duplicate keys.`,
+        duplicateKeys: duplicates,
+      };
+    }
+  }
+};
+
+export const isDataValidationError = (
+  errors: DataValidationError[] | undefined,
+): errors is DataValidationError[] => errors !== undefined;
+
+export const validateRatingData = (carrier: Carrier): DataValidationError[] | undefined => {
+  let errors: DataValidationError[] = [];
+  let basePath = carrier.NativeRating?.Path ?? '';
+
+  let error = validate(resolve(basePath, 'zones.json'), 'zones');
+  if (error) errors.push(error);
+
+  carrier.NativeRating?.RateCards?.forEach((rateCard) => {
+    error = validate(resolve(basePath, rateCard.Id, 'rates.json'), 'rates');
+    if (error) errors.push(error);
+    error = validate(resolve(basePath, rateCard.Id, 'variables.json'), 'variables');
+    if (error) errors.push(error);
+  });
+
+  return errors.length > 0 ? errors : undefined;
+};

package/src/carrier-app.ts

@@ -1,11 +1,11 @@
-import { obsoleteAppError } from '@shipengine/connect-runtime';
-
-/**
- * @deprecated Connect apps should no longer instantiate themselves.
- * See https://connect.shipengine.com/getting-started/v2-v4-upgrade/ for more information on upgrading.
- */
-export class CarrierApp {
-  constructor(_: unknown) {
-    obsoleteAppError();
-  }
-}
+import { obsoleteAppError } from '@shipengine/connect-runtime';
+
+/**
+ * @deprecated Connect apps should no longer instantiate themselves.
+ * See https://connect.shipengine.com/getting-started/v2-v4-upgrade/ for more information on upgrading.
+ */
+export class CarrierApp {
+  constructor(_: unknown) {
+    obsoleteAppError();
+  }
+}

package/src/constants.ts

@@ -1,2 +1,2 @@
-// Name of the file that will contain rating logic used by Native Rating
-export const rateLogicName = 'rate-shipments.js';
+// Name of the file that will contain rating logic used by Native Rating
+export const rateLogicName = 'rate-shipments.js';

package/src/customs.ts

@@ -1,51 +1,51 @@
-import {
-  DocumentDpi,
-  DocumentTemplate,
-  getDocuments,
-  GetDocumentsRequest,
-} from '@shipengine/connect-runtime';
-import { LabelPackage } from './models/labels/label-package';
-import { CreateLabelRequest } from './requests';
-import { CreateLabelResponse } from './responses';
-
-export const getCustoms = async (
-  carrierName: string,
-  request: CreateLabelRequest | GetDocumentsRequest,
-): Promise<CreateLabelResponse> => {
-  const requestWithCarrierName: GetDocumentsRequest = Object.assign(
-    { document_dpi: DocumentDpi.Dpi_203 },
-    request,
-    { carrier_name: carrierName, metadata: { carrier_code: 'customs' } },
-  );
-
-  return await getDocuments(requestWithCarrierName, <DocumentTemplate>{ api_code: 'customs' });
-};
-
-export const combineDocuments = (
-  labelsResponse: CreateLabelResponse,
-  customsResponse: CreateLabelResponse,
-): CreateLabelResponse => {
-  if (customsResponse?.documents) {
-    //concat documents
-    labelsResponse.documents = labelsResponse?.documents?.concat(customsResponse?.documents);
-    const mergeByTrackingNumber = (
-      labelPackages: LabelPackage[],
-      customsPackages: LabelPackage[],
-    ) =>
-      labelPackages.map((labels) => {
-        const customs = customsPackages.find(
-          (customs) => labels.tracking_number === customs.tracking_number,
-        );
-        if (customs?.documents) {
-          labels.documents = labels.documents?.concat(customs.documents);
-        }
-        return labels;
-      });
-    if (labelsResponse.packages && customsResponse.packages)
-      labelsResponse.packages = mergeByTrackingNumber(
-        labelsResponse.packages,
-        customsResponse.packages,
-      );
-  }
-  return labelsResponse;
-};
+import {
+  DocumentDpi,
+  DocumentTemplate,
+  getDocuments,
+  GetDocumentsRequest,
+} from '@shipengine/connect-runtime';
+import { LabelPackage } from './models/labels/label-package';
+import { CreateLabelRequest } from './requests';
+import { CreateLabelResponse } from './responses';
+
+export const getCustoms = async (
+  carrierName: string,
+  request: CreateLabelRequest | GetDocumentsRequest,
+): Promise<CreateLabelResponse> => {
+  const requestWithCarrierName: GetDocumentsRequest = Object.assign(
+    { document_dpi: DocumentDpi.Dpi_203 },
+    request,
+    { carrier_name: carrierName, metadata: { carrier_code: 'customs' } },
+  );
+
+  return await getDocuments(requestWithCarrierName, <DocumentTemplate>{ api_code: 'customs' });
+};
+
+export const combineDocuments = (
+  labelsResponse: CreateLabelResponse,
+  customsResponse: CreateLabelResponse,
+): CreateLabelResponse => {
+  if (customsResponse?.documents) {
+    //concat documents
+    labelsResponse.documents = labelsResponse?.documents?.concat(customsResponse?.documents);
+    const mergeByTrackingNumber = (
+      labelPackages: LabelPackage[],
+      customsPackages: LabelPackage[],
+    ) =>
+      labelPackages.map((labels) => {
+        const customs = customsPackages.find(
+          (customs) => labels.tracking_number === customs.tracking_number,
+        );
+        if (customs?.documents) {
+          labels.documents = labels.documents?.concat(customs.documents);
+        }
+        return labels;
+      });
+    if (labelsResponse.packages && customsResponse.packages)
+      labelsResponse.packages = mergeByTrackingNumber(
+        labelsResponse.packages,
+        customsResponse.packages,
+      );
+  }
+  return labelsResponse;
+};

package/src/index.ts

@@ -1,12 +1,12 @@
-export * as models from './models';
-export * as requests from './requests';
-export * as responses from './responses';
-
-export * from './app';
-export * from './constants';
-export * from './models';
-export * from './requests';
-export * from './responses';
-export * from './spec';
-export * from './carrier-app';
-export * from './customs';
+export * as models from './models';
+export * as requests from './requests';
+export * as responses from './responses';
+
+export * from './app';
+export * from './constants';
+export * from './models';
+export * from './requests';
+export * from './responses';
+export * from './spec';
+export * from './carrier-app';
+export * from './customs';

package/src/models/accessibility-types.ts

@@ -1,6 +1,6 @@
-export enum AccessibilityTypes {
-  /** @description Products being shipped accessible during delivery.*/
-  Accessible = 'accessible',
-  /** @description Products being shipped inaccessible during delivery.*/
-  Inaccessible = 'inaccessible',
-}
+export enum AccessibilityTypes {
+  /** @description Products being shipped accessible during delivery.*/
+  Accessible = 'accessible',
+  /** @description Products being shipped inaccessible during delivery.*/
+  Inaccessible = 'inaccessible',
+}

package/src/models/addresses/address-base-schema.ts

@@ -1,19 +1,19 @@
-import Joi from 'joi';
-
-export const AddressBaseSchema = Joi.object({
-  name: Joi.string().optional().empty(),
-  first_name: Joi.string().optional().empty(),
-  last_name: Joi.string().optional().empty(),
-  email: Joi.string().email().optional().empty(),
-  phone_number: Joi.string().optional().empty(),
-  company_name: Joi.string().optional().empty(),
-  address_lines: Joi.array().items(Joi.string()).optional(),
-  city_locality: Joi.string().optional().empty(),
-  state_province: Joi.string().optional().empty(),
-  postal_code: Joi.string().required(),
-  country_code: Joi.string().required(),
-  address_residential_indicator: Joi.string().optional().empty(),
-  is_eu: Joi.boolean().optional(),
-  address_metadata: Joi.object().optional().empty(),
-  instructions: Joi.string().optional().empty(),
-});
+import Joi from 'joi';
+
+export const AddressBaseSchema = Joi.object({
+  name: Joi.string().optional().empty(),
+  first_name: Joi.string().optional().empty(),
+  last_name: Joi.string().optional().empty(),
+  email: Joi.string().email().optional().empty(),
+  phone_number: Joi.string().optional().empty(),
+  company_name: Joi.string().optional().empty(),
+  address_lines: Joi.array().items(Joi.string()).optional(),
+  city_locality: Joi.string().optional().empty(),
+  state_province: Joi.string().optional().empty(),
+  postal_code: Joi.string().required(),
+  country_code: Joi.string().required(),
+  address_residential_indicator: Joi.string().optional().empty(),
+  is_eu: Joi.boolean().optional(),
+  address_metadata: Joi.object().optional().empty(),
+  instructions: Joi.string().optional().empty(),
+});