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

package/src/app/metadata/native-rating-configuration.ts

@@ -1,22 +1,22 @@
-import Joi from 'joi';
-import { fileExists } from './custom-validators/file-exists';
-import { RateCard, RateCardSchema } from './rate-card';
-
-/** Configuration for attaching Native Rating to a carrier */
-export interface NativeRatingConfiguration {
-  /** @description Default rate card to use for rating */
-  DefaultRateCardId?: string;
-  /** @description Can users manage their own rates */
-  SupportsUserManagedRates?: boolean;
-  /** Path to rating logic and rate card data for this carrier */
-  Path?: string;
-  /** Array of rate cards for the carrier */
-  RateCards?: RateCard[];
-}
-
-export const NativeRatingConfigurationSchema = Joi.object({
-  DefaultRateCardId: Joi.string().optional(),
-  SupportsUserManagedRates: Joi.boolean().optional(),
-  Path: Joi.string().optional().custom(fileExists, 'implementation path exists'),
-  RateCards: Joi.array().optional().items(RateCardSchema).unique('Id'),
-});
+import Joi from 'joi';
+import { fileExists } from './custom-validators/file-exists';
+import { RateCard, RateCardSchema } from './rate-card';
+
+/** Configuration for attaching Native Rating to a carrier */
+export interface NativeRatingConfiguration {
+  /** @description Default rate card to use for rating */
+  DefaultRateCardId?: string;
+  /** @description Can users manage their own rates */
+  SupportsUserManagedRates?: boolean;
+  /** Path to rating logic and rate card data for this carrier */
+  Path?: string;
+  /** Array of rate cards for the carrier */
+  RateCards?: RateCard[];
+}
+
+export const NativeRatingConfigurationSchema = Joi.object({
+  DefaultRateCardId: Joi.string().optional(),
+  SupportsUserManagedRates: Joi.boolean().optional(),
+  Path: Joi.string().optional().custom(fileExists, 'implementation path exists'),
+  RateCards: Joi.array().optional().items(RateCardSchema).unique('Id'),
+});

package/src/app/metadata/normalized-errors.ts

@@ -1,22 +1,22 @@
-import Joi from 'joi';
-
-export interface NormalizedErrors {
-  /** Original carrier error or regex which represent carrier error */
-  source_error: string;
-  /** Pattern based on which method will try to match original carrier error. Allowed values "fixed", "regex" */
-  match_pattern: string;
-  /** Short description of error */
-  error_code: string;
-  /** Custom error message which will replace standardized error message in response */
-  override_custom_error_message?: string;
-  /** Module api code when error is related to specific module, not for whole integration */
-  source_api_code?: string;
-}
-
-export const NormalizedErrorsConfigurationSchema = Joi.object({
-  source_error: Joi.string().required(),
-  match_pattern: Joi.string().required(),
-  error_code: Joi.string().required(),
-  override_custom_error_message: Joi.string().optional(),
-  source_api_code: Joi.string().optional(),
-});
+import Joi from 'joi';
+
+export interface NormalizedErrors {
+  /** Original carrier error or regex which represent carrier error */
+  source_error: string;
+  /** Pattern based on which method will try to match original carrier error. Allowed values "fixed", "regex" */
+  match_pattern: string;
+  /** Short description of error */
+  error_code: string;
+  /** Custom error message which will replace standardized error message in response */
+  override_custom_error_message?: string;
+  /** Module api code when error is related to specific module, not for whole integration */
+  source_api_code?: string;
+}
+
+export const NormalizedErrorsConfigurationSchema = Joi.object({
+  source_error: Joi.string().required(),
+  match_pattern: Joi.string().required(),
+  error_code: Joi.string().required(),
+  override_custom_error_message: Joi.string().optional(),
+  source_api_code: Joi.string().optional(),
+});

package/src/app/metadata/package-rating-group-dimensions.ts

@@ -1,34 +1,34 @@
-import Joi from 'joi';
-import { DimensionUnit } from '../../models';
-import { DimensionUnitSchema } from '../../models/units/dimension-unit-schema';
-
-/** @description Dimensions specific to a package rate class */
-export interface PackageRatingGroupDimensions {
-  /** @description Unit of the dimensions */
-  Unit: DimensionUnit;
-  /** @description Length of the package */
-  Length?: number;
-  /** @description Width of the package */
-  Width?: number;
-  /** @description Height of the package */
-  Height?: number;
-  /** @description Girth of the package as defined by the carrier */
-  Girth?: number;
-  /** @description No two sides exceed this amount */
-  NoTwoSides?: number;
-  /** @description Length plus girth should not exceed this amount */
-  LengthPlusGirth?: number;
-  /** @description Volume of the package */
-  Volume?: number;
-}
-
-export const PackageRatingGroupDimensionsSchema = Joi.object({
-  Unit: DimensionUnitSchema.required(),
-  Length: Joi.number().min(0).optional(),
-  Width: Joi.number().min(0).optional(),
-  Height: Joi.number().min(0).optional(),
-  NoTwoSides: Joi.number().min(0).optional(),
-  LengthPlusGirth: Joi.number().min(0).optional(),
-  Girth: Joi.number().min(0).optional(),
-  Volume: Joi.number().min(0).optional(),
-});
+import Joi from 'joi';
+import { DimensionUnit } from '../../models';
+import { DimensionUnitSchema } from '../../models/units/dimension-unit-schema';
+
+/** @description Dimensions specific to a package rate class */
+export interface PackageRatingGroupDimensions {
+  /** @description Unit of the dimensions */
+  Unit: DimensionUnit;
+  /** @description Length of the package */
+  Length?: number;
+  /** @description Width of the package */
+  Width?: number;
+  /** @description Height of the package */
+  Height?: number;
+  /** @description Girth of the package as defined by the carrier */
+  Girth?: number;
+  /** @description No two sides exceed this amount */
+  NoTwoSides?: number;
+  /** @description Length plus girth should not exceed this amount */
+  LengthPlusGirth?: number;
+  /** @description Volume of the package */
+  Volume?: number;
+}
+
+export const PackageRatingGroupDimensionsSchema = Joi.object({
+  Unit: DimensionUnitSchema.required(),
+  Length: Joi.number().min(0).optional(),
+  Width: Joi.number().min(0).optional(),
+  Height: Joi.number().min(0).optional(),
+  NoTwoSides: Joi.number().min(0).optional(),
+  LengthPlusGirth: Joi.number().min(0).optional(),
+  Girth: Joi.number().min(0).optional(),
+  Volume: Joi.number().min(0).optional(),
+});

package/src/app/metadata/package-rating-group-weight.ts

@@ -1,16 +1,16 @@
-import Joi from 'joi';
-import { WeightUnit } from '../../models';
-import { WeightUnitSchema } from '../../models/units/weight-unit-schema';
-
-/** @description Weight of a package rating group */
-export interface PackageRatingGroupWeight {
-  /** @description Unit of the weight */
-  Unit: WeightUnit;
-  /** @description Actual weight value */
-  Value: number;
-}
-
-export const PackageRatingGroupWeightSchema = Joi.object({
-  Unit: WeightUnitSchema.required(),
-  Value: Joi.number().min(0),
-});
+import Joi from 'joi';
+import { WeightUnit } from '../../models';
+import { WeightUnitSchema } from '../../models/units/weight-unit-schema';
+
+/** @description Weight of a package rating group */
+export interface PackageRatingGroupWeight {
+  /** @description Unit of the weight */
+  Unit: WeightUnit;
+  /** @description Actual weight value */
+  Value: number;
+}
+
+export const PackageRatingGroupWeightSchema = Joi.object({
+  Unit: WeightUnitSchema.required(),
+  Value: Joi.number().min(0),
+});

package/src/app/metadata/package-rating-group.ts

@@ -1,34 +1,34 @@
-import Joi from 'joi';
-import {
-  PackageRatingGroupDimensions,
-  PackageRatingGroupDimensionsSchema,
-} from './package-rating-group-dimensions';
-import {
-  PackageRatingGroupWeight,
-  PackageRatingGroupWeightSchema,
-} from './package-rating-group-weight';
-
-/** @description Details about how packages are related to rates */
-export interface PackageRatingGroup {
-  /** @description Id of the rating group */
-  Id: string;
-  /** @description Id of the package type to which this rating group corresponds */
-  PackageTypeId: string;
-  /** @description Name of the package rating group */
-  Name: string;
-  /** @description This is the code that will be sent to requests, this should be the same code the carrier's api would expect */
-  CarrierPackageTypeCode: string;
-  /** @description Maximum allowable dimensions of packages for the rating group */
-  DimensionLimits?: PackageRatingGroupDimensions;
-  /** @description Maximum allowable weight of packages for the rating group */
-  MaxWeight?: PackageRatingGroupWeight;
-}
-
-export const PackageRatingGroupSchema = Joi.object({
-  Id: Joi.string().required().max(50),
-  PackageTypeId: Joi.string().uuid().required(),
-  Name: Joi.string().required().max(50),
-  CarrierPackageTypeCode: Joi.string().required().max(50), // Copied from package type validation
-  DimensionLimits: PackageRatingGroupDimensionsSchema.optional(),
-  MaxWeight: PackageRatingGroupWeightSchema.optional(),
-});
+import Joi from 'joi';
+import {
+  PackageRatingGroupDimensions,
+  PackageRatingGroupDimensionsSchema,
+} from './package-rating-group-dimensions';
+import {
+  PackageRatingGroupWeight,
+  PackageRatingGroupWeightSchema,
+} from './package-rating-group-weight';
+
+/** @description Details about how packages are related to rates */
+export interface PackageRatingGroup {
+  /** @description Id of the rating group */
+  Id: string;
+  /** @description Id of the package type to which this rating group corresponds */
+  PackageTypeId: string;
+  /** @description Name of the package rating group */
+  Name: string;
+  /** @description This is the code that will be sent to requests, this should be the same code the carrier's api would expect */
+  CarrierPackageTypeCode: string;
+  /** @description Maximum allowable dimensions of packages for the rating group */
+  DimensionLimits?: PackageRatingGroupDimensions;
+  /** @description Maximum allowable weight of packages for the rating group */
+  MaxWeight?: PackageRatingGroupWeight;
+}
+
+export const PackageRatingGroupSchema = Joi.object({
+  Id: Joi.string().required().max(50),
+  PackageTypeId: Joi.string().uuid().required(),
+  Name: Joi.string().required().max(50),
+  CarrierPackageTypeCode: Joi.string().required().max(50), // Copied from package type validation
+  DimensionLimits: PackageRatingGroupDimensionsSchema.optional(),
+  MaxWeight: PackageRatingGroupWeightSchema.optional(),
+});

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

@@ -1,48 +1,48 @@
-import Joi from 'joi';
-import { ApiCodeRegex, ApiCodeValidationMessage } from '@shipengine/connect-runtime';
-
-export enum RequiredToShipEnum {
-  Weight = 'Weight',
-  Dimensions = 'Dimensions',
-}
-
-/** @description Package details */
-export interface PackageType {
-  /** @description The unique identifier for this package type. It should not change after being published */
-  Id: string;
-  /** @description The name of this package type ex: 'Eco friendly box' */
-  Name: string;
-  /** @description The identifier for this package type to be used in API calls. Must be snake cased and unique */
-  ApiCode?: string;
-  /** @description This is the code that will be sent to requests, this should be the same code the carrier's api would expect */
-  CarrierPackageTypeCode: string;
-  /** @description This is a human readable description about what the packaging is */
-  Description?: string;
-  /** @description This is an abbreviation of the name if necessary */
-  Abbreviation?: string;
-  /** @description Package attributes include International, Domestic, Consolidator */
-  PackageAttributes: PackageAttribute[];
-  /** @description What information is required to ship this package type Weight and or Dimensions */
-  RequiredToShip?: RequiredToShipEnum[];
-}
-
-export enum PackageAttribute {
-  International = 'International',
-  Domestic = 'Domestic',
-  Consolidator = 'Consolidator',
-}
-
-export const PackageTypeSchema = Joi.object({
-  Id: Joi.string().uuid().required(),
-  Name: Joi.string().required().max(50),
-  ApiCode: Joi.string().optional().pattern(ApiCodeRegex, ApiCodeValidationMessage),
-  CarrierPackageTypeCode: Joi.string().required().max(50),
-  Description: Joi.string().optional().max(500),
-  Abbreviation: Joi.string().optional().max(20),
-  PackageAttributes: Joi.array()
-    .required()
-    .items(Joi.string().valid(...Object.values(PackageAttribute))),
-  RequiredToShip: Joi.array()
-    .optional()
-    .items(Joi.string().valid(...Object.values(RequiredToShipEnum))),
-});
+import Joi from 'joi';
+import { ApiCodeRegex, ApiCodeValidationMessage } from '@shipengine/connect-runtime';
+
+export enum RequiredToShipEnum {
+  Weight = 'Weight',
+  Dimensions = 'Dimensions',
+}
+
+/** @description Package details */
+export interface PackageType {
+  /** @description The unique identifier for this package type. It should not change after being published */
+  Id: string;
+  /** @description The name of this package type ex: 'Eco friendly box' */
+  Name: string;
+  /** @description The identifier for this package type to be used in API calls. Must be snake cased and unique */
+  ApiCode?: string;
+  /** @description This is the code that will be sent to requests, this should be the same code the carrier's api would expect */
+  CarrierPackageTypeCode: string;
+  /** @description This is a human readable description about what the packaging is */
+  Description?: string;
+  /** @description This is an abbreviation of the name if necessary */
+  Abbreviation?: string;
+  /** @description Package attributes include International, Domestic, Consolidator */
+  PackageAttributes: PackageAttribute[];
+  /** @description What information is required to ship this package type Weight and or Dimensions */
+  RequiredToShip?: RequiredToShipEnum[];
+}
+
+export enum PackageAttribute {
+  International = 'International',
+  Domestic = 'Domestic',
+  Consolidator = 'Consolidator',
+}
+
+export const PackageTypeSchema = Joi.object({
+  Id: Joi.string().uuid().required(),
+  Name: Joi.string().required().max(50),
+  ApiCode: Joi.string().optional().pattern(ApiCodeRegex, ApiCodeValidationMessage),
+  CarrierPackageTypeCode: Joi.string().required().max(50),
+  Description: Joi.string().optional().max(500),
+  Abbreviation: Joi.string().optional().max(20),
+  PackageAttributes: Joi.array()
+    .required()
+    .items(Joi.string().valid(...Object.values(PackageAttribute))),
+  RequiredToShip: Joi.array()
+    .optional()
+    .items(Joi.string().valid(...Object.values(RequiredToShipEnum))),
+});

package/src/app/metadata/rate-card.ts

@@ -1,14 +1,14 @@
-import Joi from 'joi';
-
-/** Configuration for a given rate card */
-export interface RateCard {
-  /** Externally facing id of the rate card. */
-  Id: string;
-  /** Currency of the rate card. This uses the three-digit currency code format. */
-  Currency: string;
-}
-
-export const RateCardSchema = Joi.object({
-  Id: Joi.string().required(),
-  Currency: Joi.string().required().length(3),
-});
+import Joi from 'joi';
+
+/** Configuration for a given rate card */
+export interface RateCard {
+  /** Externally facing id of the rate card. */
+  Id: string;
+  /** Currency of the rate card. This uses the three-digit currency code format. */
+  Currency: string;
+}
+
+export const RateCardSchema = Joi.object({
+  Id: Joi.string().required(),
+  Currency: Joi.string().required().length(3),
+});

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

@@ -1,15 +1,15 @@
-import Joi from 'joi';
-
-/** @description Common shipping service classes */
-export enum ServiceClassEnum {
-  Unspecified = 'Unspecified',
-  Ground = 'Ground',
-  OneDay = 'OneDay',
-  OneDayEarly = 'OneDayEarly',
-  OneDayEarlyAm = 'OneDayEarlyAm',
-  TwoDay = 'TwoDay',
-  TwoDayEarly = 'TwoDayEarly',
-  ThreeDay = 'ThreeDay',
-}
-
-export const ServiceClassEnumSchema = Joi.string().valid(...Object.values(ServiceClassEnum));
+import Joi from 'joi';
+
+/** @description Common shipping service classes */
+export enum ServiceClassEnum {
+  Unspecified = 'Unspecified',
+  Ground = 'Ground',
+  OneDay = 'OneDay',
+  OneDayEarly = 'OneDayEarly',
+  OneDayEarlyAm = 'OneDayEarlyAm',
+  TwoDay = 'TwoDay',
+  TwoDayEarly = 'TwoDayEarly',
+  ThreeDay = 'ThreeDay',
+}
+
+export const ServiceClassEnumSchema = Joi.string().valid(...Object.values(ServiceClassEnum));

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

@@ -1,12 +1,12 @@
-import Joi from 'joi';
-
-/** @description Common shipping service grades */
-export enum ServiceGradeEnum {
-  Unspecified = 'Unspecified',
-  Economy = 'Economy',
-  Expedited = 'Expedited',
-  Overnight = 'Overnight',
-  Standard = 'Standard',
-}
-
-export const ServiceGradeEnumSchema = Joi.string().valid(...Object.values(ServiceGradeEnum));
+import Joi from 'joi';
+
+/** @description Common shipping service grades */
+export enum ServiceGradeEnum {
+  Unspecified = 'Unspecified',
+  Economy = 'Economy',
+  Expedited = 'Expedited',
+  Overnight = 'Overnight',
+  Standard = 'Standard',
+}
+
+export const ServiceGradeEnumSchema = Joi.string().valid(...Object.values(ServiceGradeEnum));

package/src/app/metadata/service-point-feature.ts

@@ -1,13 +1,13 @@
-import Joi from 'joi';
-
-export enum ServicePointFeaturesEnum {
-  DropOffPoint = 'drop_off_point',
-  PickupPoint = 'pickup_point',
-  PrintServices = 'print_services',
-  AfterHoursLocker = 'after_hours_locker',
-  AfterHoursDropbox = 'after_hours_dropbox',
-}
-
-export const ServicePointFeaturesEnumSchema = Joi.string().valid(
-  ...Object.values(ServicePointFeaturesEnum),
-);
+import Joi from 'joi';
+
+export enum ServicePointFeaturesEnum {
+  DropOffPoint = 'drop_off_point',
+  PickupPoint = 'pickup_point',
+  PrintServices = 'print_services',
+  AfterHoursLocker = 'after_hours_locker',
+  AfterHoursDropbox = 'after_hours_dropbox',
+}
+
+export const ServicePointFeaturesEnumSchema = Joi.string().valid(
+  ...Object.values(ServicePointFeaturesEnum),
+);

package/src/app/metadata/service-point-location-type.ts

@@ -1,10 +1,10 @@
-import Joi from 'joi';
-
-export enum ServicePointLocationTypeEnum {
-  PUDO = 'pudo',
-  Locker = 'locker',
-}
-
-export const ServicePointLocationTypeEnumSchema = Joi.string().valid(
-  ...Object.values(ServicePointLocationTypeEnum),
-);
+import Joi from 'joi';
+
+export enum ServicePointLocationTypeEnum {
+  PUDO = 'pudo',
+  Locker = 'locker',
+}
+
+export const ServicePointLocationTypeEnumSchema = Joi.string().valid(
+  ...Object.values(ServicePointLocationTypeEnum),
+);

package/src/app/metadata/service-required-properties.ts

@@ -1,11 +1,11 @@
-import Joi from 'joi';
-
-/** @description Properties that may be required */
-export enum ServiceRequiredPropertiesEnum {
-  Weight = 'Weight',
-  Dimensions = 'Dimensions',
-}
-
-export const ServiceRequiredPropertiesEnumSchema = Joi.string().valid(
-  ...Object.values(ServiceRequiredPropertiesEnum),
-);
+import Joi from 'joi';
+
+/** @description Properties that may be required */
+export enum ServiceRequiredPropertiesEnum {
+  Weight = 'Weight',
+  Dimensions = 'Dimensions',
+}
+
+export const ServiceRequiredPropertiesEnumSchema = Joi.string().valid(
+  ...Object.values(ServiceRequiredPropertiesEnum),
+);

package/src/app/metadata/services-attributes.ts

@@ -1,24 +1,24 @@
-import Joi from 'joi';
-
-export enum ServiceAttributesEnum {
-  Returns = 'Returns',
-  MultiPackage = 'MultiPackage',
-  Tracking = 'Tracking',
-  ConsolidatorService = 'ConsolidatorService',
-  AutomatedTrackingAllowed = 'AutomatedTrackingAllowed',
-  ManifestDigital = 'ManifestDigital',
-  ManifestPhysical = 'ManifestPhysical',
-  SameDayService = 'SameDayService',
-  Tip = 'Tip',
-  DeliveryWindow = 'DeliveryWindow',
-  PickupOnLabelCreation = 'PickupOnLabelCreation',
-  PaperlessLabel = 'PaperlessLabel',
-  InboundTrackingUpdates = 'InboundTrackingUpdates',
-  NonZeroRating = 'NonZeroRating',
-  AllowsShippingToServicePoint = 'AllowsShippingToServicePoint',
-  AllowsShippingOnSunday = 'AllowsShippingOnSunday',
-}
-
-export const ServiceAttributesEnumSchema = Joi.string().valid(
-  ...Object.values(ServiceAttributesEnum),
-);
+import Joi from 'joi';
+
+export enum ServiceAttributesEnum {
+  Returns = 'Returns',
+  MultiPackage = 'MultiPackage',
+  Tracking = 'Tracking',
+  ConsolidatorService = 'ConsolidatorService',
+  AutomatedTrackingAllowed = 'AutomatedTrackingAllowed',
+  ManifestDigital = 'ManifestDigital',
+  ManifestPhysical = 'ManifestPhysical',
+  SameDayService = 'SameDayService',
+  Tip = 'Tip',
+  DeliveryWindow = 'DeliveryWindow',
+  PickupOnLabelCreation = 'PickupOnLabelCreation',
+  PaperlessLabel = 'PaperlessLabel',
+  InboundTrackingUpdates = 'InboundTrackingUpdates',
+  NonZeroRating = 'NonZeroRating',
+  AllowsShippingToServicePoint = 'AllowsShippingToServicePoint',
+  AllowsShippingOnSunday = 'AllowsShippingOnSunday',
+}
+
+export const ServiceAttributesEnumSchema = Joi.string().valid(
+  ...Object.values(ServiceAttributesEnum),
+);