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

package/src/models/relay-points/relay-point-address-schema.ts

@@ -1,11 +1,11 @@
-import Joi from 'joi';
-
-export const RelayPointAddressSchema = Joi.object({
-  relay_point_id: Joi.string().required(),
-  company_name: Joi.string().optional().empty(),
-  address_lines: Joi.array().items(Joi.string()).required(),
-  city_locality: Joi.string().required(),
-  state_province: Joi.string().required(),
-  postal_code: Joi.string().required(),
-  country_code: Joi.string().required(),
-});
+import Joi from 'joi';
+
+export const RelayPointAddressSchema = Joi.object({
+  relay_point_id: Joi.string().required(),
+  company_name: Joi.string().optional().empty(),
+  address_lines: Joi.array().items(Joi.string()).required(),
+  city_locality: Joi.string().required(),
+  state_province: Joi.string().required(),
+  postal_code: Joi.string().required(),
+  country_code: Joi.string().required(),
+});

package/src/models/relay-points/relay-point-address.ts

@@ -1,10 +1,10 @@
-/** @description The address information corresponding to a specific relay point */
-export class RelayPointAddress {
-  relay_point_id!: string;
-  company_name?: string;
-  address_lines!: string[];
-  city_locality!: string;
-  state_province!: string;
-  postal_code!: string;
-  country_code!: string;
-}
+/** @description The address information corresponding to a specific relay point */
+export class RelayPointAddress {
+  relay_point_id!: string;
+  company_name?: string;
+  address_lines!: string[];
+  city_locality!: string;
+  state_province!: string;
+  postal_code!: string;
+  country_code!: string;
+}

package/src/models/relay-points/relay-point-details-schema.ts

@@ -1,7 +1,7 @@
-import Joi from 'joi';
-import { RelayPointAddressSchema } from './relay-point-address-schema';
-
-export const RelayPointDetailsSchema = Joi.object({
-  ship_to: RelayPointAddressSchema.required(),
-  ship_from: RelayPointAddressSchema.required(),
-});
+import Joi from 'joi';
+import { RelayPointAddressSchema } from './relay-point-address-schema';
+
+export const RelayPointDetailsSchema = Joi.object({
+  ship_to: RelayPointAddressSchema.required(),
+  ship_from: RelayPointAddressSchema.required(),
+});

package/src/models/relay-points/relay-point-details.ts

@@ -1,7 +1,7 @@
-import { RelayPointAddress } from './relay-point-address';
-
-/** @description Details of the relay points to be used to create labels */
-export class RelayPointDetails {
-  ship_to!: RelayPointAddress;
-  ship_from!: RelayPointAddress;
-}
+import { RelayPointAddress } from './relay-point-address';
+
+/** @description Details of the relay points to be used to create labels */
+export class RelayPointDetails {
+  ship_to!: RelayPointAddress;
+  ship_from!: RelayPointAddress;
+}

package/src/models/relay-points/relay-point-schema.ts

@@ -1,10 +1,10 @@
-import Joi from 'joi';
-import { RelayPointAddressSchema } from './relay-point-address-schema';
-import { OpeningTimesSchema } from './opening-times-schema';
-
-export const RelayPointSchema = RelayPointAddressSchema.keys({
-  phone: Joi.string().optional(),
-  longitude: Joi.number().optional(),
-  latitude: Joi.number().optional(),
-  opening_times: OpeningTimesSchema.required(),
-});
+import Joi from 'joi';
+import { RelayPointAddressSchema } from './relay-point-address-schema';
+import { OpeningTimesSchema } from './opening-times-schema';
+
+export const RelayPointSchema = RelayPointAddressSchema.keys({
+  phone: Joi.string().optional(),
+  longitude: Joi.number().optional(),
+  latitude: Joi.number().optional(),
+  opening_times: OpeningTimesSchema.required(),
+});

package/src/models/relay-points/relay-point.ts

@@ -1,10 +1,10 @@
-import { RelayPointAddress } from './relay-point-address';
-import { OpeningTimes } from './opening-times';
-
-/** @description Basic structure for a relay point */
-export class RelayPoint extends RelayPointAddress {
-  phone?: string;
-  longitude?: number;
-  latitude?: number;
-  opening_times!: OpeningTimes;
-}
+import { RelayPointAddress } from './relay-point-address';
+import { OpeningTimes } from './opening-times';
+
+/** @description Basic structure for a relay point */
+export class RelayPoint extends RelayPointAddress {
+  phone?: string;
+  longitude?: number;
+  latitude?: number;
+  opening_times!: OpeningTimes;
+}

package/src/models/resource-download-schema.ts

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

package/src/models/resource-download.ts

@@ -1,7 +1,7 @@
-/** @description Basic structure for a resource to download */
-export class ResourceDownload {
-  /** @deprecated This property is not used by the platform */
-  href?: string;
-  /** @description Base64 encoded data for the resource */
-  data?: string;
-}
+/** @description Basic structure for a resource to download */
+export class ResourceDownload {
+  /** @deprecated This property is not used by the platform */
+  href?: string;
+  /** @description Base64 encoded data for the resource */
+  data?: string;
+}

package/src/models/service-points/day-of-operation-schema.ts

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

package/src/models/service-points/day-of-operation.ts

@@ -1,7 +1,7 @@
-/** @description Indicates a specific date window that a service point is open */
-export class DayOfOperation {
-  /** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
-  start?: string;
-  /** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
-  end?: string;
-}
+/** @description Indicates a specific date window that a service point is open */
+export class DayOfOperation {
+  /** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
+  start?: string;
+  /** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
+  end?: string;
+}

package/src/models/service-points/hours-of-operation-schema.ts

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

package/src/models/service-points/hours-of-operation.ts

@@ -1,7 +1,7 @@
-/** @description Indicates a specific time window that a service point is open */
-export class HoursOfOperation {
-  /** @description The open time expressed in ISO 8601 time only format */
-  open?: string;
-  /** @description The close time expressed in ISO 8601 time only format */
-  close?: string;
-}
+/** @description Indicates a specific time window that a service point is open */
+export class HoursOfOperation {
+  /** @description The open time expressed in ISO 8601 time only format */
+  open?: string;
+  /** @description The close time expressed in ISO 8601 time only format */
+  close?: string;
+}

package/src/models/service-points/index.ts

@@ -1,6 +1,6 @@
-export * from './service-point-response-address-schema';
-export * from './service-point-response-address';
-export * from './service-point-schema';
-export * from './service-point';
-export * from './weekly-hours-of-operation-schema';
-export * from './weekly-hours-of-operation';
+export * from './service-point-response-address-schema';
+export * from './service-point-response-address';
+export * from './service-point-schema';
+export * from './service-point';
+export * from './weekly-hours-of-operation-schema';
+export * from './weekly-hours-of-operation';

package/src/models/service-points/search-radius-unit.ts

@@ -1,5 +1,5 @@
-/** @description Unit of measurement for search radius */
-export enum SearchRadiusUnit {
-  Miles = 'miles',
-  Kilometers = 'kilometers',
-}
+/** @description Unit of measurement for search radius */
+export enum SearchRadiusUnit {
+  Miles = 'miles',
+  Kilometers = 'kilometers',
+}

package/src/models/service-points/search-radius.ts

@@ -1,13 +1,13 @@
-import { SearchRadiusUnit } from './search-radius-unit';
-
-/** @description Basic structure for service point search radius */
-export class SearchRadius {
-  /** @description Search radius in miles */
-  radius_in_miles?: number;
-  /** @description Search radius in kilometers */
-  radius_in_kilometers?: number;
-  /** @description Search radius in the original unit */
-  source_radius?: number;
-  /** @description Search radius unit */
-  source_radius_unit!: SearchRadiusUnit;
-}
+import { SearchRadiusUnit } from './search-radius-unit';
+
+/** @description Basic structure for service point search radius */
+export class SearchRadius {
+  /** @description Search radius in miles */
+  radius_in_miles?: number;
+  /** @description Search radius in kilometers */
+  radius_in_kilometers?: number;
+  /** @description Search radius in the original unit */
+  source_radius?: number;
+  /** @description Search radius unit */
+  source_radius_unit!: SearchRadiusUnit;
+}

package/src/models/service-points/service-point-response-address-schema.ts

@@ -1,14 +1,14 @@
-import Joi from 'joi';
-import { LatLongSchema } from '../tracking/lat-long-schema';
-
-export const ServicePointResponseAddressSchema = Joi.object({
-  phone_number: Joi.string().optional().empty(),
-  company_name: Joi.string().optional().empty(),
-  description: Joi.string().optional().empty(),
-  geo: LatLongSchema.optional(),
-  address_lines: Joi.array().items(Joi.string()).required(),
-  city_locality: Joi.string().required(),
-  state_province: Joi.string().required(),
-  postal_code: Joi.string().required(),
-  country_code: Joi.string().required(),
-});
+import Joi from 'joi';
+import { LatLongSchema } from '../tracking/lat-long-schema';
+
+export const ServicePointResponseAddressSchema = Joi.object({
+  phone_number: Joi.string().optional().empty(),
+  company_name: Joi.string().optional().empty(),
+  description: Joi.string().optional().empty(),
+  geo: LatLongSchema.optional(),
+  address_lines: Joi.array().items(Joi.string()).required(),
+  city_locality: Joi.string().required(),
+  state_province: Joi.string().required(),
+  postal_code: Joi.string().required(),
+  country_code: Joi.string().required(),
+});

package/src/models/service-points/service-point-response-address.ts

@@ -1,7 +1,7 @@
-import { ServicePointAddress } from '../addresses/service-point-address';
-
-/** @description The address information corresponding to a specific service point */
-export class ServicePointResponseAddress extends ServicePointAddress {
-  /** @description Description of the location */
-  description?: string;
-}
+import { ServicePointAddress } from '../addresses/service-point-address';
+
+/** @description The address information corresponding to a specific service point */
+export class ServicePointResponseAddress extends ServicePointAddress {
+  /** @description Description of the location */
+  description?: string;
+}

package/src/models/service-points/service-point-schema.ts

@@ -1,13 +1,13 @@
-import Joi from 'joi';
-import { ServicePointFeaturesEnumSchema } from '../../app/metadata/service-point-feature';
-import { ServicePointLocationTypeEnumSchema } from '../../app/metadata/service-point-location-type';
-import { ServicePointResponseAddressSchema } from './service-point-response-address-schema';
-import { WeeklyHoursOfOperationSchema } from './weekly-hours-of-operation-schema';
-
-export const ServicePointSchema = Joi.object({
-  service_point_id: Joi.string().required(),
-  address: ServicePointResponseAddressSchema.required(),
-  hours_of_operation: WeeklyHoursOfOperationSchema.required(),
-  features: Joi.array().items(ServicePointFeaturesEnumSchema).optional(),
-  type: ServicePointLocationTypeEnumSchema.optional(),
-});
+import Joi from 'joi';
+import { ServicePointFeaturesEnumSchema } from '../../app/metadata/service-point-feature';
+import { ServicePointLocationTypeEnumSchema } from '../../app/metadata/service-point-location-type';
+import { ServicePointResponseAddressSchema } from './service-point-response-address-schema';
+import { WeeklyHoursOfOperationSchema } from './weekly-hours-of-operation-schema';
+
+export const ServicePointSchema = Joi.object({
+  service_point_id: Joi.string().required(),
+  address: ServicePointResponseAddressSchema.required(),
+  hours_of_operation: WeeklyHoursOfOperationSchema.required(),
+  features: Joi.array().items(ServicePointFeaturesEnumSchema).optional(),
+  type: ServicePointLocationTypeEnumSchema.optional(),
+});

package/src/models/service-points/service-point-shipment.ts

@@ -1,11 +1,11 @@
-import { WeightDetails } from './../units/weight-details';
-import { ShipmentPackage } from './shipment-package';
-
-/** @description The shipment information related to the service point */
-export class ServicePointShipment {
-  /** @description Detailed information about the weight of this item */
-  total_weight?: WeightDetails;
-
-  /**@description Pacakges in shipment */
-  packages?: Array<ShipmentPackage>;
-}
+import { WeightDetails } from './../units/weight-details';
+import { ShipmentPackage } from './shipment-package';
+
+/** @description The shipment information related to the service point */
+export class ServicePointShipment {
+  /** @description Detailed information about the weight of this item */
+  total_weight?: WeightDetails;
+
+  /**@description Pacakges in shipment */
+  packages?: Array<ShipmentPackage>;
+}

package/src/models/service-points/service-point.ts

@@ -1,24 +1,24 @@
-import { ServicePointFeaturesEnum } from '../../app/metadata/service-point-feature';
-import { ServicePointLocationTypeEnum } from '../../app/metadata/service-point-location-type';
-import { ServicePointResponseAddress } from './service-point-response-address';
-import { WeeklyHoursOfOperation } from './weekly-hours-of-operation';
-import { DayOfOperation } from './day-of-operation';
-import { SpecialOpeningTime } from './special-opening-time';
-
-/** @description Basic structure for a service point */
-export class ServicePoint {
-  /** @description The identifier for the carrier's service point */
-  service_point_id!: string;
-  /** @description The address where the service point is located */
-  address!: ServicePointResponseAddress;
-  /** @description Weekly hours of operation for the service point */
-  hours_of_operation!: WeeklyHoursOfOperation;
-  /** @description Features supported by the service point */
-  features?: ServicePointFeaturesEnum[];
-  /** @description Temporary closures days */
-  temporary_closures?: DayOfOperation[];
-  /** @description Special opening times */
-  special_opening_times?: SpecialOpeningTime[];
-  /** @description Location type like PUDOs, parcelshops, postoffices, lockers, retailers own stores etc. */
-  type?: ServicePointLocationTypeEnum;
-}
+import { ServicePointFeaturesEnum } from '../../app/metadata/service-point-feature';
+import { ServicePointLocationTypeEnum } from '../../app/metadata/service-point-location-type';
+import { ServicePointResponseAddress } from './service-point-response-address';
+import { WeeklyHoursOfOperation } from './weekly-hours-of-operation';
+import { DayOfOperation } from './day-of-operation';
+import { SpecialOpeningTime } from './special-opening-time';
+
+/** @description Basic structure for a service point */
+export class ServicePoint {
+  /** @description The identifier for the carrier's service point */
+  service_point_id!: string;
+  /** @description The address where the service point is located */
+  address!: ServicePointResponseAddress;
+  /** @description Weekly hours of operation for the service point */
+  hours_of_operation!: WeeklyHoursOfOperation;
+  /** @description Features supported by the service point */
+  features?: ServicePointFeaturesEnum[];
+  /** @description Temporary closures days */
+  temporary_closures?: DayOfOperation[];
+  /** @description Special opening times */
+  special_opening_times?: SpecialOpeningTime[];
+  /** @description Location type like PUDOs, parcelshops, postoffices, lockers, retailers own stores etc. */
+  type?: ServicePointLocationTypeEnum;
+}

package/src/models/service-points/shipment-package.ts

@@ -1,5 +1,5 @@
-import { DimensionDetails } from './../units/dimension-details';
-
-export class ShipmentPackage {
-  dimensions?: DimensionDetails;
-}
+import { DimensionDetails } from './../units/dimension-details';
+
+export class ShipmentPackage {
+  dimensions?: DimensionDetails;
+}

package/src/models/service-points/special-opening-time-schema.ts

@@ -1,8 +1,8 @@
-import Joi from 'joi';
-import { HoursOfOperationSchema } from './hours-of-operation-schema';
-
-export const SpecialOpeningTimeSchema = Joi.object({
-  start: Joi.string().optional().empty(),
-  end: Joi.string().optional().empty(),
-  hours_of_operation: HoursOfOperationSchema.optional(),
-});
+import Joi from 'joi';
+import { HoursOfOperationSchema } from './hours-of-operation-schema';
+
+export const SpecialOpeningTimeSchema = Joi.object({
+  start: Joi.string().optional().empty(),
+  end: Joi.string().optional().empty(),
+  hours_of_operation: HoursOfOperationSchema.optional(),
+});

package/src/models/service-points/special-opening-time.ts

@@ -1,11 +1,11 @@
-import { HoursOfOperation } from './hours-of-operation';
-
-/** @description Indicates a specific date window that a service point is open with opening hours */
-export class SpecialOpeningTime {
-  /** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
-  start?: string;
-  /** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
-  end?: string;
-  /** @description The opening hours */
-  hours_of_operation?: HoursOfOperation[];
-}
+import { HoursOfOperation } from './hours-of-operation';
+
+/** @description Indicates a specific date window that a service point is open with opening hours */
+export class SpecialOpeningTime {
+  /** @description The starting day expressed in ISO 8601 date(yyyy-mm-dd) only format */
+  start?: string;
+  /** @description The close time expressed in ISO 8601 date(yyyy-mm-dd) only format */
+  end?: string;
+  /** @description The opening hours */
+  hours_of_operation?: HoursOfOperation[];
+}

package/src/models/service-points/weekly-hours-of-operation-schema.ts

@@ -1,12 +1,12 @@
-import Joi from 'joi';
-import { HoursOfOperationSchema } from './hours-of-operation-schema';
-
-export const WeeklyHoursOfOperationSchema = Joi.object({
-  monday: HoursOfOperationSchema.optional(),
-  tuesday: HoursOfOperationSchema.optional(),
-  wednesday: HoursOfOperationSchema.optional(),
-  thursday: HoursOfOperationSchema.optional(),
-  friday: HoursOfOperationSchema.optional(),
-  saturday: HoursOfOperationSchema.optional(),
-  sunday: HoursOfOperationSchema.optional(),
-});
+import Joi from 'joi';
+import { HoursOfOperationSchema } from './hours-of-operation-schema';
+
+export const WeeklyHoursOfOperationSchema = Joi.object({
+  monday: HoursOfOperationSchema.optional(),
+  tuesday: HoursOfOperationSchema.optional(),
+  wednesday: HoursOfOperationSchema.optional(),
+  thursday: HoursOfOperationSchema.optional(),
+  friday: HoursOfOperationSchema.optional(),
+  saturday: HoursOfOperationSchema.optional(),
+  sunday: HoursOfOperationSchema.optional(),
+});

package/src/models/service-points/weekly-hours-of-operation.ts

@@ -1,12 +1,12 @@
-import { HoursOfOperation } from './hours-of-operation';
-
-/** @description The times during the week that the relay point is open */
-export class WeeklyHoursOfOperation {
-  monday?: HoursOfOperation[];
-  tuesday?: HoursOfOperation[];
-  wednesday?: HoursOfOperation[];
-  thursday?: HoursOfOperation[];
-  friday?: HoursOfOperation[];
-  saturday?: HoursOfOperation[];
-  sunday?: HoursOfOperation[];
-}
+import { HoursOfOperation } from './hours-of-operation';
+
+/** @description The times during the week that the relay point is open */
+export class WeeklyHoursOfOperation {
+  monday?: HoursOfOperation[];
+  tuesday?: HoursOfOperation[];
+  wednesday?: HoursOfOperation[];
+  thursday?: HoursOfOperation[];
+  friday?: HoursOfOperation[];
+  saturday?: HoursOfOperation[];
+  sunday?: HoursOfOperation[];
+}

package/src/models/shipment-item.ts

@@ -1,7 +1,7 @@
-/** And item that is part of a shipment */
-export interface ShipmentItem {
-  /** Sku of the item */
-  sku?: string;
-  /** Quantity of the item */
-  quantity?: number;
-}
+/** And item that is part of a shipment */
+export interface ShipmentItem {
+  /** Sku of the item */
+  sku?: string;
+  /** Quantity of the item */
+  quantity?: number;
+}

package/src/models/signatory.ts

@@ -1,9 +1,9 @@
-/** @description Specify the name, title and place of the signatory responsible for the dangerous goods shipment. */
-export class Signatory {
-  /** @description Name of the signatory. */
-  contact_name?: string;
-  /** @description Title of the signatory. */
-  title?: string;
-  /** @description Place of the signatory. */
-  place?: string;
-}
+/** @description Specify the name, title and place of the signatory responsible for the dangerous goods shipment. */
+export class Signatory {
+  /** @description Name of the signatory. */
+  contact_name?: string;
+  /** @description Title of the signatory. */
+  title?: string;
+  /** @description Place of the signatory. */
+  place?: string;
+}

package/src/models/taxes/index.ts

@@ -1,3 +1,3 @@
-export * from './tax-identifier-type';
-export * from './tax-identifier';
-export * from './tax-type';
+export * from './tax-identifier-type';
+export * from './tax-identifier';
+export * from './tax-type';

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

@@ -1,9 +1,9 @@
-import Joi from 'joi';
-import { TaxIdentifierTypeSchema } from './tax-identifier-type-schema';
-
-export const TaxIdentifierSchema = Joi.object({
-  id: Joi.string(),
-  type: TaxIdentifierTypeSchema,
-  registration_county: Joi.string().optional(),
-  description: Joi.string().optional(),
-});
+import Joi from 'joi';
+import { TaxIdentifierTypeSchema } from './tax-identifier-type-schema';
+
+export const TaxIdentifierSchema = Joi.object({
+  id: Joi.string(),
+  type: TaxIdentifierTypeSchema,
+  registration_county: Joi.string().optional(),
+  description: Joi.string().optional(),
+});

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

@@ -1,4 +1,4 @@
-import Joi from 'joi';
-import { TaxIdentifierType } from './tax-identifier-type';
-
-export const TaxIdentifierTypeSchema = Joi.string().valid(...Object.values(TaxIdentifierType));
+import Joi from 'joi';
+import { TaxIdentifierType } from './tax-identifier-type';
+
+export const TaxIdentifierTypeSchema = Joi.string().valid(...Object.values(TaxIdentifierType));