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

package/src/models/manifests/manifest-request-shipment.ts

@@ -1,9 +1,8 @@
-import { ShippedShipment } from '../pickup/shipped-shipment';
-import { ManifestCustoms } from './manifest-customs';
-
-export class ManifestRequestShipment extends ShippedShipment {
-  manifest_request_shipment_id!: string;
-  ship_datetime?: string;
-  reference?: string;
-  customs?: ManifestCustoms;
-}
+import { ShippedShipment } from '../pickup/shipped-shipment';
+import { ManifestCustoms } from './manifest-customs';
+
+export class ManifestRequestShipment extends ShippedShipment {
+  manifest_request_shipment_id!: string;
+  ship_datetime?: string;
+  customs?: ManifestCustoms;
+}

package/src/models/manifests/manifest-schema.ts

@@ -1,10 +1,10 @@
-import Joi from 'joi';
-import { ResourceDownloadSchema } from '../resource-download-schema';
-
-export const ManifestSchema = Joi.object({
-  manifest_id: Joi.string().optional().empty(),
-  document_download: ResourceDownloadSchema.optional(),
-  document_href: Joi.string().optional().empty(),
-  document_data: Joi.string().optional().empty(),
-  manifest_request_shipment_ids: Joi.array().optional().items(Joi.string()),
-});
+import Joi from 'joi';
+import { ResourceDownloadSchema } from '../resource-download-schema';
+
+export const ManifestSchema = Joi.object({
+  manifest_id: Joi.string().optional().empty(),
+  document_download: ResourceDownloadSchema.optional(),
+  document_href: Joi.string().optional().empty(),
+  document_data: Joi.string().optional().empty(),
+  manifest_request_shipment_ids: Joi.array().optional().items(Joi.string()),
+});

package/src/models/manifests/manifest.ts

@@ -1,14 +1,14 @@
-import { ResourceDownload } from '../resource-download';
-
-/** @description This model represents a single manifest created with a shipping provider. */
-export class Manifest {
-  /** @description The unique identifier for this manifest. */
-  manifest_id?: string;
-  /** @description The resource and where it can be downloaded */
-  document_download?: ResourceDownload;
-  /** @deprecated This property is no longer used please use the document_download */
-  document_href?: string;
-  /** @deprecated This property is no longer used please use the document_download */
-  document_data?: string;
-  manifest_request_shipment_ids?: string[];
-}
+import { ResourceDownload } from '../resource-download';
+
+/** @description This model represents a single manifest created with a shipping provider. */
+export class Manifest {
+  /** @description The unique identifier for this manifest. */
+  manifest_id?: string;
+  /** @description The resource and where it can be downloaded */
+  document_download?: ResourceDownload;
+  /** @deprecated This property is no longer used please use the document_download */
+  document_href?: string;
+  /** @deprecated This property is no longer used please use the document_download */
+  document_data?: string;
+  manifest_request_shipment_ids?: string[];
+}

package/src/models/native-rating/context-results.ts

@@ -1,3 +1,3 @@
-export interface ContextResults<T> {
-  [dataKey: string]: T;
-}
+export interface ContextResults<T> {
+  [dataKey: string]: T;
+}

package/src/models/native-rating/get-rates.ts

@@ -1,9 +1,9 @@
-import { ContextResults } from './context-results';
-import { NumericCurrency } from './numeric-currency';
-
-export type GetRatesResults = ContextResults<NumericCurrency>;
-
-/** Function to get rates from the context */
-export interface GetRates {
-  (dataKeys: string[]): Promise<GetRatesResults>;
-}
+import { ContextResults } from './context-results';
+import { NumericCurrency } from './numeric-currency';
+
+export type GetRatesResults = ContextResults<NumericCurrency>;
+
+/** Function to get rates from the context */
+export interface GetRates {
+  (dataKeys: string[]): Promise<GetRatesResults>;
+}

package/src/models/native-rating/get-variables.ts

@@ -1,8 +1,8 @@
-import { ContextResults } from './context-results';
-
-export type GetVariableResults = ContextResults<any>;
-
-/** Function to get rating variables from the context */
-export interface GetVariables {
-  (dataKeys: string[]): Promise<GetVariableResults>;
-}
+import { ContextResults } from './context-results';
+
+export type GetVariableResults = ContextResults<any>;
+
+/** Function to get rating variables from the context */
+export interface GetVariables {
+  (dataKeys: string[]): Promise<GetVariableResults>;
+}

package/src/models/native-rating/get-zone.ts

@@ -1,9 +1,9 @@
-import { ContextResults } from './context-results';
-
-export type GetZoneResults = ContextResults<any>;
-
-/** Function to get zone data from the context */
-export interface GetZone {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  (dataKeys: string[]): Promise<GetZoneResults>;
-}
+import { ContextResults } from './context-results';
+
+export type GetZoneResults = ContextResults<any>;
+
+/** Function to get zone data from the context */
+export interface GetZone {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  (dataKeys: string[]): Promise<GetZoneResults>;
+}

package/src/models/native-rating/implementation-type.ts

@@ -1,33 +1,33 @@
-import type { GetRatesRequest, Rate } from '@shipengine/connect-carrier-api';
-import type { RatingContext } from './rating-context';
-
-/** A rate request shipment with its corresponding id */
-export interface ShipmentAndId {
-  /** rate_request_identifier for the rate request */
-  id: string;
-  /** Shipment for the rate request */
-  shipment: GetRatesRequest;
-}
-
-/** Rate results with its corresponding rate request id */
-export interface RateResultsAndId {
-  /** rate_request_identifier for the corresponding rate request */
-  id: string;
-  /** Error, if any */
-  error?: unknown;
-  /** Rates for a given rate request */
-  rates: Rate[];
-}
-
-/** Implementation of a carrier */
-export interface RatingCarrier {
-  /** Rate shipments
-   * @param context Native Rating context that can be used by the implementation to interact with the underlying service
-   * @param shipment Shipments that should be rated
-   * @returns List of rates for the given shipments
-   */
-  rateShipments: (context: RatingContext, shipment: ShipmentAndId[]) => Promise<RateResultsAndId[]>;
-}
-
-/** Signify a validation error from the carrier */
-export class CarrierValidationError extends Error {}
+import type { GetRatesRequest, Rate } from '@shipengine/connect-carrier-api';
+import type { RatingContext } from './rating-context';
+
+/** A rate request shipment with its corresponding id */
+export interface ShipmentAndId {
+  /** rate_request_identifier for the rate request */
+  id: string;
+  /** Shipment for the rate request */
+  shipment: GetRatesRequest;
+}
+
+/** Rate results with its corresponding rate request id */
+export interface RateResultsAndId {
+  /** rate_request_identifier for the corresponding rate request */
+  id: string;
+  /** Error, if any */
+  error?: unknown;
+  /** Rates for a given rate request */
+  rates: Rate[];
+}
+
+/** Implementation of a carrier */
+export interface RatingCarrier {
+  /** Rate shipments
+   * @param context Native Rating context that can be used by the implementation to interact with the underlying service
+   * @param shipment Shipments that should be rated
+   * @returns List of rates for the given shipments
+   */
+  rateShipments: (context: RatingContext, shipment: ShipmentAndId[]) => Promise<RateResultsAndId[]>;
+}
+
+/** Signify a validation error from the carrier */
+export class CarrierValidationError extends Error {}

package/src/models/native-rating/index.ts

@@ -1,7 +1,7 @@
-export * from './context-results';
-export * from './get-rates';
-export * from './get-variables';
-export * from './get-zone';
-export * from './implementation-type';
-export * from './numeric-currency';
-export * from './rating-context';
+export * from './context-results';
+export * from './get-rates';
+export * from './get-variables';
+export * from './get-zone';
+export * from './implementation-type';
+export * from './numeric-currency';
+export * from './rating-context';

package/src/models/native-rating/numeric-currency.ts

@@ -1,5 +1,5 @@
-/** NumericCurrency so that we don't have to convert from the string Currency all over the place */
-export interface NumericCurrency {
-  currency: string;
-  amount: number | undefined;
-}
+/** NumericCurrency so that we don't have to convert from the string Currency all over the place */
+export interface NumericCurrency {
+  currency: string;
+  amount: number | undefined;
+}

package/src/models/native-rating/rating-context.ts

@@ -1,19 +1,19 @@
-import { Logger } from 'winston';
-import { GetVariables } from './get-variables';
-import { GetRates } from './get-rates';
-import { GetZone } from './get-zone';
-
-/** Rates request context */
-export interface RatingContext {
-  /** Function to get rates for given keys */
-  getRates: GetRates;
-
-  /** Function to get variables for given keys */
-  getVariables: GetVariables;
-
-  /** Function to get zone for given keys */
-  getZone: GetZone;
-
-  /** Logger that implementers can use */
-  log: Logger;
-}
+import { Logger } from 'winston';
+import { GetVariables } from './get-variables';
+import { GetRates } from './get-rates';
+import { GetZone } from './get-zone';
+
+/** Rates request context */
+export interface RatingContext {
+  /** Function to get rates for given keys */
+  getRates: GetRates;
+
+  /** Function to get variables for given keys */
+  getVariables: GetVariables;
+
+  /** Function to get zone for given keys */
+  getZone: GetZone;
+
+  /** Logger that implementers can use */
+  log: Logger;
+}

package/src/models/package.ts

@@ -1,29 +1,29 @@
-import { DimensionDetails } from './units/dimension-details';
-import { WeightDetails } from './units/weight-details';
-import { Currency } from './currency';
-import { LabelMessage } from './labels/label-message';
-import { Customs } from './customs';
-import { Products } from './products';
-import { DangerousGoodsPackageInfo } from './dangerous-good/dangerous-goods-package-info';
-
-/** @description Basic structure for a package */
-export class Package {
-  /** @description Package code defined for the carrier in ShipEngine. */
-  package_code?: string;
-  /** @description A summary of the content of a given package. Required to ship to and from Mexico. Maximum length of 35 characters. */
-  content_description?: string;
-  /** @description Details about the dimensions of the package */
-  dimension_details?: DimensionDetails;
-  /** @description Details about the weight of the package */
-  weight_details?: WeightDetails;
-  /** @description The insured value of this package. */
-  insured_value!: Currency;
-  /** @description The message the seller requested to have on their label */
-  label_messages?: LabelMessage;
-  /** @deprecated For shipment-level information, the shipment `customs` object should be used, and for parcel-level items, the `packages.products` array should be used. */
-  customs?: Customs;
-  /** @description List of products goods model associated with this package passed to the carrier. */
-  products?: Products[];
-  /** @description An object containing information specific to the dangerous goods aspects of an individual package. */
-  dangerous_goods_package_info?: DangerousGoodsPackageInfo;
-}
+import { DimensionDetails } from './units/dimension-details';
+import { WeightDetails } from './units/weight-details';
+import { Currency } from './currency';
+import { LabelMessage } from './labels/label-message';
+import { Customs } from './customs';
+import { Products } from './products';
+import { DangerousGoodsPackageInfo } from './dangerous-good/dangerous-goods-package-info';
+
+/** @description Basic structure for a package */
+export class Package {
+  /** @description Package code defined for the carrier in ShipEngine. */
+  package_code?: string;
+  /** @description A summary of the content of a given package. Required to ship to and from Mexico. Maximum length of 35 characters. */
+  content_description?: string;
+  /** @description Details about the dimensions of the package */
+  dimension_details?: DimensionDetails;
+  /** @description Details about the weight of the package */
+  weight_details?: WeightDetails;
+  /** @description The insured value of this package. */
+  insured_value!: Currency;
+  /** @description The message the seller requested to have on their label */
+  label_messages?: LabelMessage;
+  /** @deprecated For shipment-level information, the shipment `customs` object should be used, and for parcel-level items, the `packages.products` array should be used. */
+  customs?: Customs;
+  /** @description List of products goods model associated with this package passed to the carrier. */
+  products?: Products[];
+  /** @description An object containing information specific to the dangerous goods aspects of an individual package. */
+  dangerous_goods_package_info?: DangerousGoodsPackageInfo;
+}

package/src/models/payment-terms.ts

@@ -1,7 +1,7 @@
-/** @description This model specifies whether the payment is required before the delivery of goods or services or if credit is extended to the customer.*/
-export enum PaymentTerms {
-  /** @description Payment must be made in full before the goods or services are delivered.*/
-  Prepaid = 'prepaid',
-  /** @description Payment is deferred, allowing the customer to settle the invoice at a later agreed-upon date.*/
-  Credit = 'credit',
-}
+/** @description This model specifies whether the payment is required before the delivery of goods or services or if credit is extended to the customer.*/
+export enum PaymentTerms {
+  /** @description Payment must be made in full before the goods or services are delivered.*/
+  Prepaid = 'prepaid',
+  /** @description Payment is deferred, allowing the customer to settle the invoice at a later agreed-upon date.*/
+  Credit = 'credit',
+}

package/src/models/pickup/cancellation-details.ts

@@ -1,11 +1,11 @@
-import { CancellationReason } from './cancellation-reason';
-
-/** @description Basic structure for a cancellation */
-export class CancellationDetails {
-  /** @description The reason the pickup has been cancelled */
-  reason!: CancellationReason;
-  /** @description Additional properties about cancellation */
-  cancellation_options?: { [key: string]: string };
-  /** @description Any additional info about why the customer is cancelling the pickup */
-  remarks?: string;
-}
+import { CancellationReason } from './cancellation-reason';
+
+/** @description Basic structure for a cancellation */
+export class CancellationDetails {
+  /** @description The reason the pickup has been cancelled */
+  reason!: CancellationReason;
+  /** @description Additional properties about cancellation */
+  cancellation_options?: { [key: string]: string };
+  /** @description Any additional info about why the customer is cancelling the pickup */
+  remarks?: string;
+}

package/src/models/pickup/cancellation-reason.ts

@@ -1,8 +1,8 @@
-/** @description Reasons for cancellation */
-export enum CancellationReason {
-  Other = 'other',
-  NotReady = 'not_ready',
-  CostTooHigh = 'cost_too_high',
-  ServiceTooSlow = 'service_too_slow',
-  CarrierFailedPickup = 'carrier_failed_pickup',
-}
+/** @description Reasons for cancellation */
+export enum CancellationReason {
+  Other = 'other',
+  NotReady = 'not_ready',
+  CostTooHigh = 'cost_too_high',
+  ServiceTooSlow = 'service_too_slow',
+  CarrierFailedPickup = 'carrier_failed_pickup',
+}

package/src/models/pickup/index.ts

@@ -1,14 +1,14 @@
-export * from './cancellation-details';
-export * from './cancellation-reason';
-export * from './pickup-confirmation-schema';
-export * from './pickup-confirmation';
-export * from './pickup-contact-details';
-export * from './pickup-location-details';
-export * from './pickup-package';
-export * from './pickup-shipment-details';
-export * from './pickup-window-schema';
-export * from './pickup-window';
-export * from './shipment-identifier-schema';
-export * from './shipment-identifier';
-export * from './shipped-package';
-export * from './shipped-shipment';
+export * from './cancellation-details';
+export * from './cancellation-reason';
+export * from './pickup-confirmation-schema';
+export * from './pickup-confirmation';
+export * from './pickup-contact-details';
+export * from './pickup-location-details';
+export * from './pickup-package';
+export * from './pickup-shipment-details';
+export * from './pickup-window-schema';
+export * from './pickup-window';
+export * from './shipment-identifier-schema';
+export * from './shipment-identifier';
+export * from './shipped-package';
+export * from './shipped-shipment';

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

@@ -1,9 +1,9 @@
-import Joi from 'joi';
-import { IdentifierSchema } from '../identifier-schema';
-import { ShipmentIdentifierSchema } from './shipment-identifier-schema';
-
-export const PickupConfirmationSchema = Joi.object({
-  confirmation_id: Joi.string().optional().empty(),
-  alternate_identifiers: Joi.array().optional().items(IdentifierSchema),
-  shipment_identifiers: Joi.array().optional().items(ShipmentIdentifierSchema),
-});
+import Joi from 'joi';
+import { IdentifierSchema } from '../identifier-schema';
+import { ShipmentIdentifierSchema } from './shipment-identifier-schema';
+
+export const PickupConfirmationSchema = Joi.object({
+  confirmation_id: Joi.string().optional().empty(),
+  alternate_identifiers: Joi.array().optional().items(IdentifierSchema),
+  shipment_identifiers: Joi.array().optional().items(ShipmentIdentifierSchema),
+});

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

@@ -1,12 +1,12 @@
-import { Identifier } from '../identifier';
-import { ShipmentIdentifier } from './shipment-identifier';
-
-/** @description Basic structure for a pickup confirmation */
-export class PickupConfirmation {
-  /** @description The primary confirmation ID for this request. */
-  confirmation_id?: string;
-  /** @description Other identifiers potentially needed in other calls. */
-  alternate_identifiers?: Identifier[];
-  /** @description List of the shipments added for this pickup. */
-  shipment_identifiers?: ShipmentIdentifier[];
-}
+import { Identifier } from '../identifier';
+import { ShipmentIdentifier } from './shipment-identifier';
+
+/** @description Basic structure for a pickup confirmation */
+export class PickupConfirmation {
+  /** @description The primary confirmation ID for this request. */
+  confirmation_id?: string;
+  /** @description Other identifiers potentially needed in other calls. */
+  alternate_identifiers?: Identifier[];
+  /** @description List of the shipments added for this pickup. */
+  shipment_identifiers?: ShipmentIdentifier[];
+}

package/src/models/pickup/pickup-contact-details.ts

@@ -1,13 +1,13 @@
-/** @description Contact information for the person who will be present for the pickup. */
-export class PickupContactDetails {
-  /** @description The first name of the person who will be there for the pickup. */
-  first_name!: string;
-  /** @description The last name of the person who will be there for the pickup. */
-  last_name?: string;
-  /** @description The e-mail address of the person who will be there for the pickup. */
-  email!: string;
-  /** @description The phone number of the person who will be there for the pickup. */
-  phone_number!: string;
-  /** @description The phone extension of the person who will be there for the pickup. */
-  phone_number_extension?: string;
-}
+/** @description Contact information for the person who will be present for the pickup. */
+export class PickupContactDetails {
+  /** @description The first name of the person who will be there for the pickup. */
+  first_name!: string;
+  /** @description The last name of the person who will be there for the pickup. */
+  last_name?: string;
+  /** @description The e-mail address of the person who will be there for the pickup. */
+  email!: string;
+  /** @description The phone number of the person who will be there for the pickup. */
+  phone_number!: string;
+  /** @description The phone extension of the person who will be there for the pickup. */
+  phone_number_extension?: string;
+}

package/src/models/pickup/pickup-location-details.ts

@@ -1,11 +1,11 @@
-import { ShipFrom } from '../addresses/ship-from';
-
-/** @description Location details for pickup */
-export class PickupLocationDetails {
-  /** @description The address the pickup will take place */
-  pickup_address?: ShipFrom;
-  /** @description Any notes that may be helpful for a driver to find the pickup location */
-  location_notes?: string;
-  /** @description Custom options that are used by the carrier to determine pickup locations */
-  pickup_options?: { [key: string]: string };
-}
+import { ShipFrom } from '../addresses/ship-from';
+
+/** @description Location details for pickup */
+export class PickupLocationDetails {
+  /** @description The address the pickup will take place */
+  pickup_address?: ShipFrom;
+  /** @description Any notes that may be helpful for a driver to find the pickup location */
+  location_notes?: string;
+  /** @description Custom options that are used by the carrier to determine pickup locations */
+  pickup_options?: { [key: string]: string };
+}

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

@@ -1,22 +1,22 @@
-import { Identifier } from '../identifier';
-import { DimensionDetails } from '../units/dimension-details';
-import { WeightDetails } from '../units/weight-details';
-import { Dimensions } from '../units/dimensions';
-
-/** @description Basic structure for a package to be picked up */
-export class PickupPackage {
-  /** @description The carrier tracking number for this shipment */
-  tracking_number?: string;
-  /** @description Alternative identifiers associated with this package */
-  alternative_identifiers?: Identifier[];
-  /** @description Details about the dimensions of the package */
-  dimension_details?: DimensionDetails;
-  /** @description Details about the weight of the package */
-  weight_details?: WeightDetails;
-  /** @description The code associated with the package type */
-  package_code?: string;
-  /** @deprectated Please use the weight_details property */
-  weight?: number;
-  /** @deprectated Please use the dimension_details property */
-  dimensions?: Dimensions;
-}
+import { Identifier } from '../identifier';
+import { DimensionDetails } from '../units/dimension-details';
+import { WeightDetails } from '../units/weight-details';
+import { Dimensions } from '../units/dimensions';
+
+/** @description Basic structure for a package to be picked up */
+export class PickupPackage {
+  /** @description The carrier tracking number for this shipment */
+  tracking_number?: string;
+  /** @description Alternative identifiers associated with this package */
+  alternative_identifiers?: Identifier[];
+  /** @description Details about the dimensions of the package */
+  dimension_details?: DimensionDetails;
+  /** @description Details about the weight of the package */
+  weight_details?: WeightDetails;
+  /** @description The code associated with the package type */
+  package_code?: string;
+  /** @deprectated Please use the weight_details property */
+  weight?: number;
+  /** @deprectated Please use the dimension_details property */
+  dimensions?: Dimensions;
+}

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

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+
+export const PickupSchema = Joi.object({
+  confirmation_number: Joi.string().required(),
+  status: Joi.string().required(),
+  status_reason: Joi.string().optional(),
+});

package/src/models/pickup/pickup-shipment-details.ts

@@ -1,9 +1,9 @@
-import { ShippedShipment } from './shipped-shipment';
-
-/** @description Details for a pickup shipment */
-export class PickupShipmentDetails {
-  /** @description Service category for the carrier (ground, express, next_day) */
-  pickup_service_code?: string;
-  /** @description List of shipments to be picked up */
-  shipments?: ShippedShipment[];
-}
+import { ShippedShipment } from './shipped-shipment';
+
+/** @description Details for a pickup shipment */
+export class PickupShipmentDetails {
+  /** @description Service category for the carrier (ground, express, next_day) */
+  pickup_service_code?: string;
+  /** @description List of shipments to be picked up */
+  shipments?: ShippedShipment[];
+}

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

@@ -1,8 +1,8 @@
-import Joi from 'joi';
-
-export const PickupWindowSchema = Joi.object({
-  time_zone_iana: Joi.string().required(),
-  pickup_date: Joi.string().required().isoDate(),
-  start_time: Joi.string().optional().isoDate(),
-  end_time: Joi.string().optional().isoDate(),
-});
+import Joi from 'joi';
+
+export const PickupWindowSchema = Joi.object({
+  time_zone_iana: Joi.string().required(),
+  pickup_date: Joi.string().required().isoDate(),
+  start_time: Joi.string().optional().isoDate(),
+  end_time: Joi.string().optional().isoDate(),
+});

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

@@ -1,11 +1,11 @@
-/** @description This model represents a window of time a pickup could be made. */
-export class PickupWindow {
-  /** @description The local time zone represented in IANA. See https://www.iana.org/time-zones */
-  time_zone_iana!: string;
-  /** @description The local date the pickup will occur. Formatted per https://tools.ietf.org/html/rfc3339 */
-  pickup_date!: string;
-  /** @description The time relative to the time_zone_iana that the carrier says that the pickup could occur. Formatted per https://tools.ietf.org/html/rfc3339 */
-  start_time?: string;
-  /** @description The end of the window when the pickup could be made relative to the time_zone_iana. Formatted per https://tools.ietf.org/html/rfc3339 */
-  end_time?: string;
-}
+/** @description This model represents a window of time a pickup could be made. */
+export class PickupWindow {
+  /** @description The local time zone represented in IANA. See https://www.iana.org/time-zones */
+  time_zone_iana!: string;
+  /** @description The local date the pickup will occur. Formatted per https://tools.ietf.org/html/rfc3339 */
+  pickup_date!: string;
+  /** @description The time relative to the time_zone_iana that the carrier says that the pickup could occur. Formatted per https://tools.ietf.org/html/rfc3339 */
+  start_time?: string;
+  /** @description The end of the window when the pickup could be made relative to the time_zone_iana. Formatted per https://tools.ietf.org/html/rfc3339 */
+  end_time?: string;
+}