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

package/src/models/taxes/tax-identifier-type.ts

@@ -1,38 +1,38 @@
-/** @description Specifies the supported tax identification types  */
-export enum TaxIdentifierType {
-  /** @description Tax Identification Number  */
-  TIN = 'tin',
-  /** @description Employer Identification Number  */
-  EIN = 'ein',
-  /** @description Social Security Number  */
-  SSN = 'ssn',
-  /** @description Value Added Tax Identification Number  */
-  VAT = 'vat',
-  /** @description Economic Operators Registration and Identification Number  */
-  EORI = 'eori',
-  /** @description Import One-Stop Shop Number
-   * The IOSS allows suppliers and electronic interfaces selling imported goods to buyers in the EU to
-   * collect, declare and pay the VAT to the tax authorities, instead of making the buyer pay the VAT at the
-   * moment the goods are imported into the EU as it was previously the case (for products over 22 EUR).
-   * https://ec.europa.eu/taxation_customs/business/vat/ioss_en
-   */
-  IOSS = 'ioss',
-  /** @description Permanent Account Number
-   * A ten-character alphanumeric identifier, issued by the Indian Income Tax
-   */
-  PAN = 'pan',
-  /** @description Norway's VAT on E-Commerce number
-   * https://www.skatteetaten.no/en/business-and-organisation/vat-and-duties/vat/foreign/e-commerce-voec/
-   */
-  VOEC = 'voec',
-  /** @description Personal Customs Clearance Code (PCCC)*/
-  PCCC = 'pccc',
-  /** @description One-Stop Shop (OSS).*/
-  OSS = 'oss',
-  /** @description Passport number*/
-  PASSPORT = 'passport',
-  /** @description Australian Business Number*/
-  ABN = 'abn',
-  /** @description Windsor Framework Number*/
-  UKIMS = 'ukims',
-}
+/** @description Specifies the supported tax identification types  */
+export enum TaxIdentifierType {
+  /** @description Tax Identification Number  */
+  TIN = 'tin',
+  /** @description Employer Identification Number  */
+  EIN = 'ein',
+  /** @description Social Security Number  */
+  SSN = 'ssn',
+  /** @description Value Added Tax Identification Number  */
+  VAT = 'vat',
+  /** @description Economic Operators Registration and Identification Number  */
+  EORI = 'eori',
+  /** @description Import One-Stop Shop Number
+   * The IOSS allows suppliers and electronic interfaces selling imported goods to buyers in the EU to
+   * collect, declare and pay the VAT to the tax authorities, instead of making the buyer pay the VAT at the
+   * moment the goods are imported into the EU as it was previously the case (for products over 22 EUR).
+   * https://ec.europa.eu/taxation_customs/business/vat/ioss_en
+   */
+  IOSS = 'ioss',
+  /** @description Permanent Account Number
+   * A ten-character alphanumeric identifier, issued by the Indian Income Tax
+   */
+  PAN = 'pan',
+  /** @description Norway's VAT on E-Commerce number
+   * https://www.skatteetaten.no/en/business-and-organisation/vat-and-duties/vat/foreign/e-commerce-voec/
+   */
+  VOEC = 'voec',
+  /** @description Personal Customs Clearance Code (PCCC)*/
+  PCCC = 'pccc',
+  /** @description One-Stop Shop (OSS).*/
+  OSS = 'oss',
+  /** @description Passport number*/
+  PASSPORT = 'passport',
+  /** @description Australian Business Number*/
+  ABN = 'abn',
+  /** @description Windsor Framework Number*/
+  UKIMS = 'ukims',
+}

package/src/models/taxes/tax-identifier.ts

@@ -1,15 +1,15 @@
-import { TaxIdentifierType } from './tax-identifier-type';
-
-/** @description Entity representing a Tax Identification number, type, and country of registration */
-export class TaxIdentifier {
-  /** @description Identification number */
-  id!: string;
-  /** @description The Tax ID type */
-  type!: TaxIdentifierType;
-  /** @deprecated This property has been deprecated, please use registration_country instead */
-  registration_county?: string;
-  /** @description The country where the Tax ID is registered with */
-  registration_country?: string;
-  /** @description Description of the tax ID that may give the customs agent more context */
-  description?: string;
-}
+import { TaxIdentifierType } from './tax-identifier-type';
+
+/** @description Entity representing a Tax Identification number, type, and country of registration */
+export class TaxIdentifier {
+  /** @description Identification number */
+  id!: string;
+  /** @description The Tax ID type */
+  type!: TaxIdentifierType;
+  /** @deprecated This property has been deprecated, please use registration_country instead */
+  registration_county?: string;
+  /** @description The country where the Tax ID is registered with */
+  registration_country?: string;
+  /** @description Description of the tax ID that may give the customs agent more context */
+  description?: string;
+}

package/src/models/taxes/tax-type.ts

@@ -1,3 +1,3 @@
-export enum TaxType {
-  VAT = 'vat',
-}
+export enum TaxType {
+  VAT = 'vat',
+}

package/src/models/time-window-schema.ts

@@ -1,7 +1,7 @@
-import Joi from 'joi';
-
-export const TimeWindowSchema = Joi.object({
-  time_zone_iana: Joi.string().optional().allow(null).empty(''),
-  start_window: Joi.string().optional().allow(null).empty('').isoDate(),
-  end_window: Joi.string().optional().allow(null).empty('').isoDate(),
-});
+import Joi from 'joi';
+
+export const TimeWindowSchema = Joi.object({
+  time_zone_iana: Joi.string().optional().allow(null).empty(''),
+  start_window: Joi.string().optional().allow(null).empty('').isoDate(),
+  end_window: Joi.string().optional().allow(null).empty('').isoDate(),
+});

package/src/models/time-window.ts

@@ -1,17 +1,17 @@
-/** @description Basic structure for defining a time window */
-export class TimeWindow {
-  /** @description The local time zone represented in IANA. See https://www.iana.org/time-zones.
-   * Example: America/Chicago
-   */
-  time_zone_iana?: string;
-  /** @description The start of the window when the pickup could be made relative to the time_zone_iana.
-   * ISO 8601 format, with local offset
-   * Example: 2021-08-20T14:38:36.859237-05:00
-   */
-  start_window?: string;
-  /** @description The end of the window when the pickup could be made relative to the time_zone_iana.
-   * ISO 8601 format, with local offset
-   * Example: 2021-08-20T14:38:36.859237-05:00
-   */
-  end_window?: string;
-}
+/** @description Basic structure for defining a time window */
+export class TimeWindow {
+  /** @description The local time zone represented in IANA. See https://www.iana.org/time-zones.
+   * Example: America/Chicago
+   */
+  time_zone_iana?: string;
+  /** @description The start of the window when the pickup could be made relative to the time_zone_iana.
+   * ISO 8601 format, with local offset
+   * Example: 2021-08-20T14:38:36.859237-05:00
+   */
+  start_window?: string;
+  /** @description The end of the window when the pickup could be made relative to the time_zone_iana.
+   * ISO 8601 format, with local offset
+   * Example: 2021-08-20T14:38:36.859237-05:00
+   */
+  end_window?: string;
+}

package/src/models/tracking/imported-tracking-event-schema.ts

@@ -1,8 +1,8 @@
-import Joi from 'joi';
-import { TrackingInfoSchema } from './tracking-info-schema';
-
-export const ImportedTrackingEventSchema = Joi.object({
-  tracking_info: TrackingInfoSchema.optional(),
-  error_messages: Joi.array().optional().items(Joi.string()),
-  warning_messages: Joi.array().optional().items(Joi.string()),
-});
+import Joi from 'joi';
+import { TrackingInfoSchema } from './tracking-info-schema';
+
+export const ImportedTrackingEventSchema = Joi.object({
+  tracking_info: TrackingInfoSchema.optional(),
+  error_messages: Joi.array().optional().items(Joi.string()),
+  warning_messages: Joi.array().optional().items(Joi.string()),
+});

package/src/models/tracking/imported-tracking-event.ts

@@ -1,17 +1,17 @@
-import { TrackingInfo } from './tracking-info';
-import { UpdateMethods } from './update-method';
-
-export class ImportedTrackingEvent {
-  /** @description The tracking information for the shipment */
-  tracking_info?: TrackingInfo;
-  /**
-   * @description Optional method for updating the tracking information state, i.e. is the returned
-   * information the complete state of the package or should it be appended to the existing state.
-   * Defaults to `append` if not specified.
-   */
-  update_method?: UpdateMethods;
-  /** @description Any error messages resulting from processing the tracking event */
-  error_messages?: string[];
-  /** @description Any warning messages resulting from processing the tracking event */
-  warning_messages?: string[];
-}
+import { TrackingInfo } from './tracking-info';
+import { UpdateMethods } from './update-method';
+
+export class ImportedTrackingEvent {
+  /** @description The tracking information for the shipment */
+  tracking_info?: TrackingInfo;
+  /**
+   * @description Optional method for updating the tracking information state, i.e. is the returned
+   * information the complete state of the package or should it be appended to the existing state.
+   * Defaults to `append` if not specified.
+   */
+  update_method?: UpdateMethods;
+  /** @description Any error messages resulting from processing the tracking event */
+  error_messages?: string[];
+  /** @description Any warning messages resulting from processing the tracking event */
+  warning_messages?: string[];
+}

package/src/models/tracking/index.ts

@@ -1,16 +1,18 @@
-export * from './imported-tracking-event-schema';
-export * from './imported-tracking-event';
-export * from './lat-long-schema';
-export * from './lat-long';
-export * from './service-schema';
-export * from './service';
-export * from './standardized-status-codes-schema';
-export * from './standardized-status-codes';
-export * from './track-event-schema';
-export * from './track-event';
-export * from './tracking-attribute';
-export * from './tracking-identifier';
-export * from './tracking-info-schema';
-export * from './tracking-info';
-export * from './update-method-schema';
-export * from './update-method';
+export * from './imported-tracking-event-schema';
+export * from './imported-tracking-event';
+export * from './lat-long-schema';
+export * from './lat-long';
+export * from './service-schema';
+export * from './service';
+export * from './standardized-status-codes-schema';
+export * from './standardized-status-codes';
+export * from './track-event-schema';
+export * from './track-event';
+export * from './tracking-attribute';
+export * from './tracking-identifier';
+export * from './tracking-info-schema';
+export * from './tracking-info';
+export * from './update-method-schema';
+export * from './update-method';
+export * from './standardized-status-detail-codes';
+export * from './standardized-status-detail-codes-schema';

package/src/models/tracking/lat-long-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-
-export const LatLongSchema = Joi.object({
-  lat: Joi.number().required(),
-  long: Joi.number().required(),
-});
+import Joi from 'joi';
+
+export const LatLongSchema = Joi.object({
+  lat: Joi.number().required(),
+  long: Joi.number().required(),
+});

package/src/models/tracking/lat-long.ts

@@ -1,7 +1,7 @@
-/** @description Latitude and longitude */
-export class LatLong {
-  /** @description The latitude of the point. Represented as signed degrees. http://www.geomidpoint.com/latlon.html */
-  lat!: number;
-  /** @description The longitude of the point. Represented as signed degrees http://www.geomidpoint.com/latlon.html */
-  long!: number;
-}
+/** @description Latitude and longitude */
+export class LatLong {
+  /** @description The latitude of the point. Represented as signed degrees. http://www.geomidpoint.com/latlon.html */
+  lat!: number;
+  /** @description The longitude of the point. Represented as signed degrees http://www.geomidpoint.com/latlon.html */
+  long!: number;
+}

package/src/models/tracking/proof-of-delivery-format-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-import { ProofOfDeliveryFormat } from './proof-of-delivery-format';
-
-export const ProofOfDeliveryFormatSchema = Joi.string().valid(
-  ...Object.values(ProofOfDeliveryFormat),
-);
+import Joi from 'joi';
+import { ProofOfDeliveryFormat } from './proof-of-delivery-format';
+
+export const ProofOfDeliveryFormatSchema = Joi.string().valid(
+  ...Object.values(ProofOfDeliveryFormat),
+);

package/src/models/tracking/proof-of-delivery-format.ts

@@ -1,4 +1,4 @@
-export enum ProofOfDeliveryFormat {
-  Pdf = 'PDF',
-  Png = 'PNG',
-}
+export enum ProofOfDeliveryFormat {
+  Pdf = 'PDF',
+  Png = 'PNG',
+}

package/src/models/tracking/proof-of-delivery-schema.ts

@@ -1,7 +1,7 @@
-import Joi from 'joi';
-import { ProofOfDeliveryFormatSchema } from './proof-of-delivery-format-schema';
-
-export const ProofOfDeliverySchema = Joi.object({
-  data: Joi.string().required(),
-  format: ProofOfDeliveryFormatSchema.required(),
-});
+import Joi from 'joi';
+import { ProofOfDeliveryFormatSchema } from './proof-of-delivery-format-schema';
+
+export const ProofOfDeliverySchema = Joi.object({
+  data: Joi.string().required(),
+  format: ProofOfDeliveryFormatSchema.required(),
+});

package/src/models/tracking/proof-of-delivery.ts

@@ -1,9 +1,9 @@
-import { ProofOfDeliveryFormat } from './proof-of-delivery-format';
-
-/** @description An image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc. */
-export class ProofOfDelivery {
-  /** @description Base64 encoded data for the proof of delivery. */
-  data!: string;
-  /** @description The format the document is in.\r\nPdf - PDF\r\nPng - PNG */
-  format!: ProofOfDeliveryFormat;
-}
+import { ProofOfDeliveryFormat } from './proof-of-delivery-format';
+
+/** @description An image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc. */
+export class ProofOfDelivery {
+  /** @description Base64 encoded data for the proof of delivery. */
+  data!: string;
+  /** @description The format the document is in.\r\nPdf - PDF\r\nPng - PNG */
+  format!: ProofOfDeliveryFormat;
+}

package/src/models/tracking/service-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-
-export const ServiceSchema = Joi.object({
-  code: Joi.string().optional().empty(),
-  name: Joi.string().optional().empty(),
-});
+import Joi from 'joi';
+
+export const ServiceSchema = Joi.object({
+  code: Joi.string().optional().empty(),
+  name: Joi.string().optional().empty(),
+});

package/src/models/tracking/service.ts

@@ -1,7 +1,7 @@
-/** @description Basic structure for a tracking service */
-export class Service {
-  /** @description The code specific to a shipping provider service. */
-  code?: string;
-  /** @description The name of this shipping provider service. */
-  name?: string;
-}
+/** @description Basic structure for a tracking service */
+export class Service {
+  /** @description The code specific to a shipping provider service. */
+  code?: string;
+  /** @description The name of this shipping provider service. */
+  name?: string;
+}

package/src/models/tracking/standardized-status-codes-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-import { StandardizedStatusCodes } from './standardized-status-codes';
-
-export const StandardizedStatusCodesSchema = Joi.string().valid(
-  ...Object.values(StandardizedStatusCodes),
-);
+import Joi from 'joi';
+import { StandardizedStatusCodes } from './standardized-status-codes';
+
+export const StandardizedStatusCodesSchema = Joi.string().valid(
+  ...Object.values(StandardizedStatusCodes),
+);

package/src/models/tracking/standardized-status-codes.ts

@@ -1,11 +1,11 @@
-/** @description Status codes for tracking */
-export enum StandardizedStatusCodes {
-  Unknown = 'UN',
-  Accepted = 'AC',
-  InTransit = 'IT',
-  Delivered = 'DE',
-  Exception = 'EX',
-  DeliveryAttempt = 'AT',
-  NotYetInSystem = 'NY',
-  DeliveredToServicePoint = 'SP',
-}
+/** @description Status codes for tracking */
+export enum StandardizedStatusCodes {
+  Unknown = 'UN',
+  Accepted = 'AC',
+  InTransit = 'IT',
+  Delivered = 'DE',
+  Exception = 'EX',
+  DeliveryAttempt = 'AT',
+  NotYetInSystem = 'NY',
+  DeliveredToServicePoint = 'SP',
+}

package/src/models/tracking/standardized-status-detail-codes-schema.ts

@@ -1,8 +1,8 @@
-import Joi from 'joi';
-import { StandardizedStatusDetailCodes } from './standardized-status-detail-codes';
-
-export const StandardizedStatusDetailCodesSchema = Joi.string()
-  .valid(...Object.values(StandardizedStatusDetailCodes))
-  .messages({
-    'any.only': `{{#label}} must be a proper value. See documentation: https://connect.shipengine.com/shipping/reference/operation/Track/}`,
-  });
+import Joi from 'joi';
+import { StandardizedStatusDetailCodes } from './standardized-status-detail-codes';
+
+export const StandardizedStatusDetailCodesSchema = Joi.string()
+  .valid(...Object.values(StandardizedStatusDetailCodes))
+  .messages({
+    'any.only': `{{#label}} must be a proper value. See documentation: https://connect.shipengine.com/shipping/reference/operation/Track/}`,
+  });

package/src/models/tracking/standardized-status-detail-codes.ts

@@ -1,78 +1,78 @@
-/** @description This represents the ShipEngine supported detail codes for a shipment. */
-export enum StandardizedStatusDetailCodes {
-  CarrierStatusNotMapped = 'CARRIER_STATUS_NOT_MAPPED',
-  ShipmentCreated = 'SHIPMENT_CREATED',
-  AwaitingPickupDropOff = 'AWAITING_PICKUP_DROP_OFF',
-  DroppedOff = 'DROPPED_OFF',
-  ElecAdviceRecdByCarrier = 'ELEC_ADVICE_RECD_BY_CARRIER',
-  PickedUp = 'PICKED_UP',
-  CustomsCleared = 'CUSTOMS_CLEARED',
-  CustomsProcessing = 'CUSTOMS_PROCESSING',
-  DeliveryArrangedWithRecipient = 'DELIVERY_ARRANGED_WITH_RECIPIENT',
-  HubScanOut = 'HUB_SCAN_OUT',
-  HubScanIn = 'HUB_SCAN_IN',
-  InTransit = 'IN_TRANSIT',
-  Information = 'INFORMATION',
-  ParcelOverLabelled = 'PARCEL_OVER_LABELLED',
-  ParcelUpdateNotification = 'PARCEL_UPDATE_NOTIFICATION',
-  ReceivedByCarrier = 'RECEIVED_BY_CARRIER',
-  ReceivedLocalDeliveryDepot = 'RECEIVED_LOCAL_DELIVERY_DEPOT',
-  SubContractorEvent = 'SUB_CONTRACTOR_EVENT',
-  SubContractorReceived = 'SUB_CONTRACTOR_RECEIVED',
-  ParcelRedirected = 'PARCEL_REDIRECTED',
-  DeliveryScheduled = 'DELIVERY_SCHEDULED',
-  HubProcessing = 'HUB_PROCESSING',
-  DeliveryRescheduled = 'DELIVERY_RESCHEDULED',
-  AttemptedDelivery = 'ATTEMPTED_DELIVERY',
-  AttemptedDeliveryFinal = 'ATTEMPTED_DELIVERY_FINAL',
-  CodAmountPaid = 'COD_AMOUNT_PAID',
-  CustomerCarded = 'CUSTOMER_CARDED',
-  OutForDelivery = 'OUT_FOR_DELIVERY',
-  AwaitingCollectionFromPickupPoint = 'AWAITING_COLLECTION_FROM_PICKUP_POINT',
-  CollectAtLocalPo = 'COLLECT_AT_LOCAL_PO',
-  CustomerToCollectFromCarrier = 'CUSTOMER_TO_COLLECT_FROM_CARRIER',
-  DeliveredToReception = 'DELIVERED_TO_RECEPTION',
-  Delivered = 'DELIVERED',
-  DeliveredDamaged = 'DELIVERED_DAMAGED',
-  DeliveredInPart = 'DELIVERED_IN_PART',
-  DeliveredSpecifiedSafePlace = 'DELIVERED_SPECIFIED_SAFE_PLACE',
-  DeliveredToAlternativeDeliveryLocation = 'DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION',
-  DeliveredToNeighbour = 'DELIVERED_TO_NEIGHBOUR',
-  DeliveredToPoBox = 'DELIVERED_TO_PO_BOX',
-  ParcelCollectedFromPickupPoint = 'PARCEL_COLLECTED_FROM_PICKUP_POINT',
-  PostTransitStatus = 'POST_TRANSIT_STATUS',
-  ProofOfDelivery = 'PROOF_OF_DELIVERY',
-  PickupFailed = 'PICKUP_FAILED',
-  NotYetReceivedByCarrier = 'NOT_YET_RECEIVED_BY_CARRIER',
-  ParcelDamaged = 'PARCEL_DAMAGED',
-  AddressQuery = 'ADDRESS_QUERY',
-  CarrierDelays = 'CARRIER_DELAYS',
-  DelayedNotCarrier = 'DELAYED_NOT_CARRIER',
-  HeldByCarrier = 'HELD_BY_CARRIER',
-  HeldByCarrierForClearancePreProcessing = 'HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING',
-  HeldByCustoms = 'HELD_BY_CUSTOMS',
-  IncorrectDeclaration = 'INCORRECT_DECLARATION',
-  Misrouted = 'MISROUTED',
-  ParcelRepacked = 'PARCEL_REPACKED',
-  RecdByCarrierNoElecAdvice = 'RECD_BY_CARRIER_NO_ELEC_ADVICE',
-  CodAmountNotPaid = 'COD_AMOUNT_NOT_PAID',
-  CustomerIdentificationFailed = 'CUSTOMER_IDENTIFICATION_FAILED',
-  NoAccessToRecipientsAddress = 'NO_ACCESS_TO_RECIPIENTS_ADDRESS',
-  Cancelled = 'CANCELLED',
-  CustomerMoved = 'CUSTOMER_MOVED',
-  HazardousProhibited = 'HAZARDOUS_PROHIBITED',
-  NotCollectedFromPickupPoint = 'NOT_COLLECTED_FROM_PICKUP_POINT',
-  NotDelivered = 'NOT_DELIVERED',
-  NotDeliveredAddresseeDeceased = 'NOT_DELIVERED_ADDRESSEE_DECEASED',
-  ParcelDisposed = 'PARCEL_DISPOSED',
-  ParcelLost = 'PARCEL_LOST',
-  ParcelOutsideOfServiceCapability = 'PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY',
-  RefusedByCustomer = 'REFUSED_BY_CUSTOMER',
-  ReturnToSender = 'RETURN_TO_SENDER',
-  UnspecifiedException = 'UNSPECIFIED_EXCEPTION',
-  TrackingExpired = 'TRACKING_EXPIRED',
-  DutyNotPaid = 'DUTY_NOT_PAID',
-  ParcelRedirectedByCarrier = 'PARCEL_REDIRECTED_BY_CARRIER',
-  DeliveredToPickupPoint = 'DELIVERED_TO_PICKUP_POINT',
-  UndeliverableReturnedToSender = 'UNDELIVERABLE_RETURNED_TO_SENDER',
-}
+/** @description This represents the ShipEngine supported detail codes for a shipment. */
+export enum StandardizedStatusDetailCodes {
+  CarrierStatusNotMapped = 'CARRIER_STATUS_NOT_MAPPED',
+  ShipmentCreated = 'SHIPMENT_CREATED',
+  AwaitingPickupDropOff = 'AWAITING_PICKUP_DROP_OFF',
+  DroppedOff = 'DROPPED_OFF',
+  ElecAdviceRecdByCarrier = 'ELEC_ADVICE_RECD_BY_CARRIER',
+  PickedUp = 'PICKED_UP',
+  CustomsCleared = 'CUSTOMS_CLEARED',
+  CustomsProcessing = 'CUSTOMS_PROCESSING',
+  DeliveryArrangedWithRecipient = 'DELIVERY_ARRANGED_WITH_RECIPIENT',
+  HubScanOut = 'HUB_SCAN_OUT',
+  HubScanIn = 'HUB_SCAN_IN',
+  InTransit = 'IN_TRANSIT',
+  Information = 'INFORMATION',
+  ParcelOverLabelled = 'PARCEL_OVER_LABELLED',
+  ParcelUpdateNotification = 'PARCEL_UPDATE_NOTIFICATION',
+  ReceivedByCarrier = 'RECEIVED_BY_CARRIER',
+  ReceivedLocalDeliveryDepot = 'RECEIVED_LOCAL_DELIVERY_DEPOT',
+  SubContractorEvent = 'SUB_CONTRACTOR_EVENT',
+  SubContractorReceived = 'SUB_CONTRACTOR_RECEIVED',
+  ParcelRedirected = 'PARCEL_REDIRECTED',
+  DeliveryScheduled = 'DELIVERY_SCHEDULED',
+  HubProcessing = 'HUB_PROCESSING',
+  DeliveryRescheduled = 'DELIVERY_RESCHEDULED',
+  AttemptedDelivery = 'ATTEMPTED_DELIVERY',
+  AttemptedDeliveryFinal = 'ATTEMPTED_DELIVERY_FINAL',
+  CodAmountPaid = 'COD_AMOUNT_PAID',
+  CustomerCarded = 'CUSTOMER_CARDED',
+  OutForDelivery = 'OUT_FOR_DELIVERY',
+  AwaitingCollectionFromPickupPoint = 'AWAITING_COLLECTION_FROM_PICKUP_POINT',
+  CollectAtLocalPo = 'COLLECT_AT_LOCAL_PO',
+  CustomerToCollectFromCarrier = 'CUSTOMER_TO_COLLECT_FROM_CARRIER',
+  DeliveredToReception = 'DELIVERED_TO_RECEPTION',
+  Delivered = 'DELIVERED',
+  DeliveredDamaged = 'DELIVERED_DAMAGED',
+  DeliveredInPart = 'DELIVERED_IN_PART',
+  DeliveredSpecifiedSafePlace = 'DELIVERED_SPECIFIED_SAFE_PLACE',
+  DeliveredToAlternativeDeliveryLocation = 'DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION',
+  DeliveredToNeighbour = 'DELIVERED_TO_NEIGHBOUR',
+  DeliveredToPoBox = 'DELIVERED_TO_PO_BOX',
+  ParcelCollectedFromPickupPoint = 'PARCEL_COLLECTED_FROM_PICKUP_POINT',
+  PostTransitStatus = 'POST_TRANSIT_STATUS',
+  ProofOfDelivery = 'PROOF_OF_DELIVERY',
+  PickupFailed = 'PICKUP_FAILED',
+  NotYetReceivedByCarrier = 'NOT_YET_RECEIVED_BY_CARRIER',
+  ParcelDamaged = 'PARCEL_DAMAGED',
+  AddressQuery = 'ADDRESS_QUERY',
+  CarrierDelays = 'CARRIER_DELAYS',
+  DelayedNotCarrier = 'DELAYED_NOT_CARRIER',
+  HeldByCarrier = 'HELD_BY_CARRIER',
+  HeldByCarrierForClearancePreProcessing = 'HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING',
+  HeldByCustoms = 'HELD_BY_CUSTOMS',
+  IncorrectDeclaration = 'INCORRECT_DECLARATION',
+  Misrouted = 'MISROUTED',
+  ParcelRepacked = 'PARCEL_REPACKED',
+  RecdByCarrierNoElecAdvice = 'RECD_BY_CARRIER_NO_ELEC_ADVICE',
+  CodAmountNotPaid = 'COD_AMOUNT_NOT_PAID',
+  CustomerIdentificationFailed = 'CUSTOMER_IDENTIFICATION_FAILED',
+  NoAccessToRecipientsAddress = 'NO_ACCESS_TO_RECIPIENTS_ADDRESS',
+  Cancelled = 'CANCELLED',
+  CustomerMoved = 'CUSTOMER_MOVED',
+  HazardousProhibited = 'HAZARDOUS_PROHIBITED',
+  NotCollectedFromPickupPoint = 'NOT_COLLECTED_FROM_PICKUP_POINT',
+  NotDelivered = 'NOT_DELIVERED',
+  NotDeliveredAddresseeDeceased = 'NOT_DELIVERED_ADDRESSEE_DECEASED',
+  ParcelDisposed = 'PARCEL_DISPOSED',
+  ParcelLost = 'PARCEL_LOST',
+  ParcelOutsideOfServiceCapability = 'PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY',
+  RefusedByCustomer = 'REFUSED_BY_CUSTOMER',
+  ReturnToSender = 'RETURN_TO_SENDER',
+  UnspecifiedException = 'UNSPECIFIED_EXCEPTION',
+  TrackingExpired = 'TRACKING_EXPIRED',
+  DutyNotPaid = 'DUTY_NOT_PAID',
+  ParcelRedirectedByCarrier = 'PARCEL_REDIRECTED_BY_CARRIER',
+  DeliveredToPickupPoint = 'DELIVERED_TO_PICKUP_POINT',
+  UndeliverableReturnedToSender = 'UNDELIVERABLE_RETURNED_TO_SENDER',
+}

package/src/models/tracking/track-event-schema.ts

@@ -1,22 +1,22 @@
-import Joi from 'joi';
-import { LatLongSchema } from './lat-long-schema';
-import { StandardizedStatusCodesSchema } from './standardized-status-codes-schema';
-import { StandardizedStatusDetailCodesSchema } from './standardized-status-detail-codes-schema';
-
-export const TrackEventSchema = Joi.object({
-  event_datetime: Joi.string().optional().empty().isoDate(),
-  event_datetime_local: Joi.string().optional().empty().isoDate(),
-  event_code: Joi.string().optional().empty(),
-  carrier_detail_code: Joi.string().optional().empty(),
-  proof_of_delivery_url: Joi.string().optional().empty(),
-  description: Joi.string().optional().empty(),
-  city: Joi.string().optional().empty(),
-  state: Joi.string().optional().empty(),
-  postal_code: Joi.string().optional().empty(),
-  country: Joi.string().optional().empty(),
-  company: Joi.string().optional().empty(),
-  signer: Joi.string().optional().empty(),
-  geo: LatLongSchema.optional(),
-  status_code: StandardizedStatusCodesSchema.optional(),
-  status_detail_code: StandardizedStatusDetailCodesSchema.optional(),
-});
+import Joi from 'joi';
+import { LatLongSchema } from './lat-long-schema';
+import { StandardizedStatusCodesSchema } from './standardized-status-codes-schema';
+import { StandardizedStatusDetailCodesSchema } from './standardized-status-detail-codes-schema';
+
+export const TrackEventSchema = Joi.object({
+  event_datetime: Joi.string().optional().empty().isoDate(),
+  event_datetime_local: Joi.string().optional().empty().isoDate(),
+  event_code: Joi.string().optional().empty(),
+  carrier_detail_code: Joi.string().optional().empty(),
+  proof_of_delivery_url: Joi.string().optional().empty(),
+  description: Joi.string().optional().empty(),
+  city: Joi.string().optional().empty(),
+  state: Joi.string().optional().empty(),
+  postal_code: Joi.string().optional().empty(),
+  country: Joi.string().optional().empty(),
+  company: Joi.string().optional().empty(),
+  signer: Joi.string().optional().empty(),
+  geo: LatLongSchema.optional(),
+  status_code: StandardizedStatusCodesSchema.optional(),
+  status_detail_code: StandardizedStatusDetailCodesSchema.optional(),
+});