@shipengine/connect-carrier-api 2.3.0 → 2.3.1

package/src/app/metadata/account-modals.ts

@@ -3,17 +3,23 @@ import Joi from 'joi';
 export interface AccountModals {
   /** @description Schema for the form to register with the carrier */
   RegistrationFormSchema: {
-    formSchema: {
+    /** @deprecated Please use JsonSchema & UiSchema */
+    formSchema?: {
       jsonSchema: object;
       uiSchema: object;
     };
+    JsonSchema?: object;
+    UiSchema?: object;
   };
   /** @description  Schema for the form to update carrier settings */
   SettingsFormSchema: {
-    formSchema: {
+    /** @deprecated Please use JsonSchema & UiSchema */
+    formSchema?: {
       jsonSchema: object;
       uiSchema: object;
     };
+    JsonSchema?: object;
+    UiSchema?: object;
   };
 }
 

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

@@ -1,10 +1,5 @@
 import Joi from 'joi';
-import {
-  AuthSpecification,
-  AuthSpecificationSchema,
-  Carrier,
-  CarrierSchema,
-} from '.';
+import { AuthSpecification, AuthSpecificationSchema, Carrier, CarrierSchema } from '.';
 
 export interface CarrierAppMetadata {
   /** @description Id of the carrier app */

package/src/app/metadata/carrier.ts

@@ -1,24 +1,12 @@
 import { AccountModals, AccountModalsSchema } from './account-modals';
 import { PackageType, PackageTypeSchema } from './package-type';
 import { ShippingService, ShippingServiceSchema } from './shipping-service';
-import {
-  ShippingOptionDictionary,
-  ShippingOptionDictionarySchema,
-} from './shipping-option';
-import {
-  CountryAssociation,
-  CountryAssociationSchema,
-} from './country-association';
-import {
-  CarrierAttributeEnum,
-  CarrierAttributeEnumSchema,
-} from './carrier-attributes';
+import { ShippingOptionDictionary, ShippingOptionDictionarySchema } from './shipping-option';
+import { CountryAssociation, CountryAssociationSchema } from './country-association';
+import { CarrierAttributeEnum, CarrierAttributeEnumSchema } from './carrier-attributes';
 import { LabelFormatsEnum, LabelFormatsEnumSchema } from './label-formats';
 import { LabelSizesEnum, LabelSizesEnumSchema } from './label-sizes';
-import {
-  ConfirmationDictionary,
-  ConfirmationDictionarySchema,
-} from './confirmation-type';
+import { ConfirmationDictionary, ConfirmationDictionarySchema } from './confirmation-type';
 import { existsSync } from 'fs';
 import Joi from 'joi';
 
@@ -55,25 +43,16 @@ const fileExists = (value: string, helpers: any) => {
 export const CarrierSchema = Joi.object({
   AccountModals: AccountModalsSchema.required(),
   PackageTypes: Joi.array().optional().items(PackageTypeSchema).unique('Id'),
-  ShippingServices: Joi.array()
-    .optional()
-    .items(ShippingServiceSchema)
-    .unique('Id'),
+  ShippingServices: Joi.array().optional().items(ShippingServiceSchema).unique('Id'),
   ShippingOptions: ShippingOptionDictionarySchema.optional(),
   DefaultSupportedCountries: Joi.array()
     .optional()
     .items(CountryAssociationSchema)
     .unique('FromCountry'),
-  DefaultLabelSizes: Joi.array()
-    .optional()
-    .items(LabelSizesEnumSchema)
-    .unique(),
+  DefaultLabelSizes: Joi.array().optional().items(LabelSizesEnumSchema).unique(),
   LabelFormats: Joi.array().optional().items(LabelFormatsEnumSchema).unique(),
   DefaultConfirmationTypes: ConfirmationDictionarySchema.optional(),
-  CarrierAttributes: Joi.array()
-    .optional()
-    .items(CarrierAttributeEnumSchema)
-    .unique(),
+  CarrierAttributes: Joi.array().optional().items(CarrierAttributeEnumSchema).unique(),
   TrackingUrl: Joi.string()
     .optional()
     .pattern(

package/src/app/metadata/label-formats.ts

@@ -6,6 +6,4 @@ export enum LabelFormatsEnum {
   PNG = 'PNG',
 }
 
-export const LabelFormatsEnumSchema = Joi.string().valid(
-  ...Object.values(LabelFormatsEnum),
-);
+export const LabelFormatsEnumSchema = Joi.string().valid(...Object.values(LabelFormatsEnum));

package/src/app/metadata/label-sizes.ts

@@ -5,6 +5,4 @@ export enum LabelSizesEnum {
   Inches4x8 = 'Inches4x8',
 }
 
-export const LabelSizesEnumSchema = Joi.string().valid(
-  ...Object.values(LabelSizesEnum),
-);
+export const LabelSizesEnumSchema = Joi.string().valid(...Object.values(LabelSizesEnum));

package/src/app/metadata/monoauth.ts

@@ -67,10 +67,7 @@ export class ResponseTransformationConfiguration {
   connection_context?: MapOfStrings;
 }
 
-export const MapOfStringsSchema = Joi.object().pattern(
-  Joi.string(),
-  Joi.string(),
-);
+export const MapOfStringsSchema = Joi.object().pattern(Joi.string(), Joi.string());
 
 export const ResponseTransformationConfigurationSchema = Joi.object({
   access_token: Joi.string().required(),

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

@@ -12,6 +12,4 @@ export enum ServiceClassEnum {
   ThreeDay = 'ThreeDay',
 }
 
-export const ServiceClassEnumSchema = Joi.string().valid(
-  ...Object.values(ServiceClassEnum),
-);
+export const ServiceClassEnumSchema = Joi.string().valid(...Object.values(ServiceClassEnum));

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

@@ -9,6 +9,4 @@ export enum ServiceGradeEnum {
   Standard = 'Standard',
 }
 
-export const ServiceGradeEnumSchema = Joi.string().valid(
-  ...Object.values(ServiceGradeEnum),
-);
+export const ServiceGradeEnumSchema = Joi.string().valid(...Object.values(ServiceGradeEnum));

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

@@ -1,12 +1,6 @@
 import { ConfirmationType, ConfirmationTypeSchema } from './confirmation-type';
-import {
-  CountryAssociation,
-  CountryAssociationSchema,
-} from './country-association';
-import {
-  ServiceAttributesEnum,
-  ServiceAttributesEnumSchema,
-} from './services-attributes';
+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';
@@ -35,23 +29,11 @@ export interface ShippingService {
 }
 
 export const ShippingServiceSchema = Joi.object({
-  ConfirmationTypes: Joi.array()
-    .optional()
-    .items(ConfirmationTypeSchema)
-    .unique('Type'),
+  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(),
+  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),

package/src/models/billing/billing-categories.ts

@@ -26,6 +26,4 @@ export enum BillingCategories {
   Tip = 'tip',
 }
 
-export const BillingCategoriesSchema = Joi.string().valid(
-  ...Object.values(BillingCategories),
-);
+export const BillingCategoriesSchema = Joi.string().valid(...Object.values(BillingCategories));

package/src/models/billing/billing-line-item.ts

@@ -1,7 +1,4 @@
-import {
-  BillingCategories,
-  BillingCategoriesSchema,
-} from './billing-categories';
+import { BillingCategories, BillingCategoriesSchema } from './billing-categories';
 import { Currency, CurrencySchema } from '../currency';
 import Joi from 'joi';
 

package/src/models/documents/document-type.ts

@@ -12,6 +12,4 @@ export enum DocumentType {
   BillOfLading = 'bill_of_lading',
 }
 
-export const DocumentTypeSchema = Joi.string().valid(
-  ...Object.values(DocumentType),
-);
+export const DocumentTypeSchema = Joi.string().valid(...Object.values(DocumentType));

package/src/models/documents/document.ts

@@ -1,8 +1,5 @@
 import { DocumentType, DocumentTypeSchema } from './document-type';
-import {
-  DocumentFormat,
-  DocumentFormatSchema,
-} from '../labels/document-formats';
+import { DocumentFormat, DocumentFormatSchema } from '../labels/document-formats';
 import Joi from 'joi';
 
 /** @description Basic structure for a document */

package/src/models/labels/document-formats.ts

@@ -6,6 +6,4 @@ export enum DocumentFormat {
   Zpl = 'ZPL',
   Png = 'PNG',
 }
-export const DocumentFormatSchema = Joi.string().valid(
-  ...Object.values(DocumentFormat),
-);
+export const DocumentFormatSchema = Joi.string().valid(...Object.values(DocumentFormat));

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

@@ -1,9 +1,6 @@
 import Joi from 'joi';
 import { Identifier, IdentifierSchema } from '../identifier';
-import {
-  ShipmentIdentifier,
-  ShipmentIdentifierSchema,
-} from './shipment-identifier';
+import { ShipmentIdentifier, ShipmentIdentifierSchema } from './shipment-identifier';
 
 /** @description Basic structure for a pickup confirmation */
 export class PickupConfirmation {

package/src/models/rates/rate.ts

@@ -1,8 +1,5 @@
 import Joi from 'joi';
-import {
-  BillingLineItem,
-  BillingLineItemSchema,
-} from '../billing/billing-line-item';
+import { BillingLineItem, BillingLineItemSchema } from '../billing/billing-line-item';
 import { TimeWindow, TimeWindowSchema } from '../time-window';
 
 /** @description Basic structure for a rate */

package/src/models/tracking/update-method.ts

@@ -8,6 +8,4 @@ export enum UpdateMethods {
   Replace = 'replace',
 }
 
-export const UpdateMethodsSchema = Joi.string().valid(
-  ...Object.values(UpdateMethods),
-);
+export const UpdateMethodsSchema = Joi.string().valid(...Object.values(UpdateMethods));

package/src/responses/normalize-tracking-data-response.ts

@@ -1,10 +1,5 @@
 import { BaseResponse, BaseResponseSchema } from './base-response';
-import {
-  UpdateMethods,
-  TrackingInfo,
-  TrackingInfoSchema,
-  UpdateMethodsSchema,
-} from '../models';
+import { UpdateMethods, TrackingInfo, TrackingInfoSchema, UpdateMethodsSchema } from '../models';
 import Joi from 'joi';
 
 /** @description Basic structure for a response to normalize inbound tracking data */

package/src/responses/validate-inbound-data-response.ts

@@ -1,8 +1,5 @@
 import { BaseResponse, BaseResponseSchema } from './base-response';
-import {
-  InboundDataContentTypes,
-  InboundDataContentTypesSchema,
-} from '../models';
+import { InboundDataContentTypes, InboundDataContentTypesSchema } from '../models';
 import Joi from 'joi';
 
 /** @description Basic structure for a response to validate inbound data */