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

package/src/models/labels/label-package.ts

@@ -1,17 +1,17 @@
-import { Identifier } from '../identifier';
-import { Document } from '../documents';
-import { PaperlessDetails } from './paperless-details';
-
-/** @description Package information provided by the carrier */
-export class LabelPackage {
-  /** @description Tracking number for the package */
-  tracking_number?: string;
-  /** @description Tracking URL for the package */
-  tracking_url?: string;
-  /** @description Non-tracking alternative ids associated with this package */
-  alternative_identifiers?: Identifier[];
-  /** @description Documents associated with this package, if documents are not specified at a package level, use the Documents array at the CreateLabelResponse level. */
-  documents?: Document[];
-  /** @description Paperless details */
-  paperless_details?: PaperlessDetails;
-}
+import { Identifier } from '../identifier';
+import { Document } from '../documents';
+import { PaperlessDetails } from './paperless-details';
+
+/** @description Package information provided by the carrier */
+export class LabelPackage {
+  /** @description Tracking number for the package */
+  tracking_number?: string;
+  /** @description Tracking URL for the package */
+  tracking_url?: string;
+  /** @description Non-tracking alternative ids associated with this package */
+  alternative_identifiers?: Identifier[];
+  /** @description Documents associated with this package, if documents are not specified at a package level, use the Documents array at the CreateLabelResponse level. */
+  documents?: Document[];
+  /** @description Paperless details */
+  paperless_details?: PaperlessDetails;
+}

package/src/models/labels/paperless-details-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-
-export const PaperlessDetailsSchema = Joi.object({
-  instructions: Joi.string().optional(),
-  handoffCode: Joi.string().optional(),
-});
+import Joi from 'joi';
+
+export const PaperlessDetailsSchema = Joi.object({
+  instructions: Joi.string().optional(),
+  handoffCode: Joi.string().optional(),
+});

package/src/models/labels/paperless-details.ts

@@ -1,5 +1,5 @@
-/** @description Paperless Details Object. This object contains information on hand off code and instruction that shipper needs to follow. */
-export class PaperlessDetails {
-  instructions!: string;
-  handoff_code!: string;
-}
+/** @description Paperless Details Object. This object contains information on hand off code and instruction that shipper needs to follow. */
+export class PaperlessDetails {
+  instructions!: string;
+  handoff_code!: string;
+}

package/src/models/labels/return-label-details.ts

@@ -1,5 +1,5 @@
-/** @description Basic structure for a return label */
-export class ReturnLabelDetails {
-  /** @description A return merchandise authorization (RMA) is an associated number assigned to process the return, this number is often printed on the label, and used when the original shipper processes the inbound return. */
-  rma_number?: string;
-}
+/** @description Basic structure for a return label */
+export class ReturnLabelDetails {
+  /** @description A return merchandise authorization (RMA) is an associated number assigned to process the return, this number is often printed on the label, and used when the original shipper processes the inbound return. */
+  rma_number?: string;
+}

package/src/models/labels/void-request.ts

@@ -1,10 +1,10 @@
-import { ShippedShipment } from '../pickup/shipped-shipment';
-import { ShipFrom } from '../addresses';
-
-/** @description Basic structure for a request to void a label */
-export class VoidRequest extends ShippedShipment {
-  /** @description Uniquely identifies this request to void a label. Must be returned in a void response. */
-  void_request_id!: string;
-  /** @description The location the shipment was shipped from */
-  ship_from!: ShipFrom;
-}
+import { ShippedShipment } from '../pickup/shipped-shipment';
+import { ShipFrom } from '../addresses';
+
+/** @description Basic structure for a request to void a label */
+export class VoidRequest extends ShippedShipment {
+  /** @description Uniquely identifies this request to void a label. Must be returned in a void response. */
+  void_request_id!: string;
+  /** @description The location the shipment was shipped from */
+  ship_from!: ShipFrom;
+}

package/src/models/labels/void-response-schema.ts

@@ -1,9 +1,9 @@
-import Joi from 'joi';
-import { BillingLineItemSchema } from '../billing/billing-line-item-schema';
-
-export const VoidResponseSchema = Joi.object({
-  void_request_id: Joi.string().required(),
-  message: Joi.string().optional().empty(),
-  errors: Joi.array().optional().items(Joi.string()),
-  billing_line_items: Joi.array().optional().items(BillingLineItemSchema),
-});
+import Joi from 'joi';
+import { BillingLineItemSchema } from '../billing/billing-line-item-schema';
+
+export const VoidResponseSchema = Joi.object({
+  void_request_id: Joi.string().required(),
+  message: Joi.string().optional().empty(),
+  errors: Joi.array().optional().items(Joi.string()),
+  billing_line_items: Joi.array().optional().items(BillingLineItemSchema),
+});

package/src/models/labels/void-response.ts

@@ -1,13 +1,13 @@
-import { BillingLineItem } from '../billing';
-
-/** @description Basic structure for a response to void a label */
-export class VoidResponse {
-  /** @description Id for the void response */
-  void_request_id!: string;
-  /** @description Void message, if applicable */
-  message?: string;
-  /** @description Any errors from attempting to void */
-  errors?: string[];
-  /** @description Individual Billing Line items which remain after voiding the label, e.g. a cancellation fee */
-  billing_line_items?: BillingLineItem[];
-}
+import { BillingLineItem } from '../billing';
+
+/** @description Basic structure for a response to void a label */
+export class VoidResponse {
+  /** @description Id for the void response */
+  void_request_id!: string;
+  /** @description Void message, if applicable */
+  message?: string;
+  /** @description Any errors from attempting to void */
+  errors?: string[];
+  /** @description Individual Billing Line items which remain after voiding the label, e.g. a cancellation fee */
+  billing_line_items?: BillingLineItem[];
+}

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

@@ -1,4 +1,4 @@
-import Joi from 'joi';
-import { ManifestStatus } from './manifest-status';
-
-export const ManifestStatusSchema = Joi.string().valid(...Object.values(ManifestStatus));
+import Joi from 'joi';
+import { ManifestStatus } from './manifest-status';
+
+export const ManifestStatusSchema = Joi.string().valid(...Object.values(ManifestStatus));

package/src/models/manifest-status.ts

@@ -1,8 +1,8 @@
-/** @description Possible status values for Created Manifest */
-export enum ManifestStatus {
-  /** @description Unknown, The request is in process */
-  Unknown = 'unknown',
-  InProgress = 'in_progress',
-  Completed = 'completed',
-  Failed = 'failed',
-}
+/** @description Possible status values for Created Manifest */
+export enum ManifestStatus {
+  /** @description Unknown, The request is in process */
+  Unknown = 'unknown',
+  InProgress = 'in_progress',
+  Completed = 'completed',
+  Failed = 'failed',
+}

package/src/models/manifests/index.ts

@@ -1,6 +1,6 @@
-export * from './label';
-export * from './manifest-error-schema';
-export * from './manifest-error';
-export * from './manifest-request-shipment';
-export * from './manifest-schema';
-export * from './manifest';
+export * from './label';
+export * from './manifest-error-schema';
+export * from './manifest-error';
+export * from './manifest-request-shipment';
+export * from './manifest-schema';
+export * from './manifest';

package/src/models/manifests/label.ts

@@ -1,7 +1,7 @@
-/** @description Basic structure of a manifest label */
-export class Label {
-  /** @description The carrier tracking number for this shipment */
-  tracking_number?: string;
-  /** @description The carrier specific identifier for this shipment */
-  carrier_transaction_id?: string;
-}
+/** @description Basic structure of a manifest label */
+export class Label {
+  /** @description The carrier tracking number for this shipment */
+  tracking_number?: string;
+  /** @description The carrier specific identifier for this shipment */
+  carrier_transaction_id?: string;
+}

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

@@ -1,21 +1,21 @@
-import Joi from 'joi';
-import { CustomsContentTypesSchema } from '../customs/customs-content-types-schema';
-import { CustomsNonDeliverySchema } from '../customs/customs-non-delivery-schema';
-import { CustomsItemSchema } from '../customs/customs-item-schema';
-import { CurrencySchema } from '@shipengine/connect-carrier-api';
-import { TermsOfTradeCodeSchema } from '../inconterms/terms-of-trade-code-schema';
-import { ImporterOfRecordSchema } from '../importer-records/importer-of-record-schema';
-import { CustomsChargesSchema } from '../customs/customs-charges-schema';
-
-export const CustomsSchema = Joi.object({
-  contents: CustomsContentTypesSchema.optional(),
-  non_delivery: CustomsNonDeliverySchema.optional(),
-  buyer_shipping_amount_paid: CurrencySchema.optional(),
-  duties_paid: CurrencySchema.optional(),
-  declaration: Joi.string().optional(),
-  terms_of_trade_code: TermsOfTradeCodeSchema.optional(),
-  importer_of_record: ImporterOfRecordSchema.optional(),
-  invoice_additional_details: CustomsChargesSchema.optional(),
-  contents_explanation: Joi.string().optional(),
-  export_declaration_number: Joi.string().optional(),
-});
+import Joi from 'joi';
+import { CustomsContentTypesSchema } from '../customs/customs-content-types-schema';
+import { CustomsNonDeliverySchema } from '../customs/customs-non-delivery-schema';
+import { CustomsItemSchema } from '../customs/customs-item-schema';
+import { CurrencySchema } from '@shipengine/connect-carrier-api';
+import { TermsOfTradeCodeSchema } from '../inconterms/terms-of-trade-code-schema';
+import { ImporterOfRecordSchema } from '../importer-records/importer-of-record-schema';
+import { CustomsChargesSchema } from '../customs/customs-charges-schema';
+
+export const CustomsSchema = Joi.object({
+  contents: CustomsContentTypesSchema.optional(),
+  non_delivery: CustomsNonDeliverySchema.optional(),
+  buyer_shipping_amount_paid: CurrencySchema.optional(),
+  duties_paid: CurrencySchema.optional(),
+  declaration: Joi.string().optional(),
+  terms_of_trade_code: TermsOfTradeCodeSchema.optional(),
+  importer_of_record: ImporterOfRecordSchema.optional(),
+  invoice_additional_details: CustomsChargesSchema.optional(),
+  contents_explanation: Joi.string().optional(),
+  export_declaration_number: Joi.string().optional(),
+});

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

@@ -1,33 +1,33 @@
-import {
-  Currency,
-  CustomsContentTypes,
-  CustomsItem,
-  CustomsNonDelivery,
-} from '@shipengine/connect-carrier-api';
-import { TermsOfTradeCode } from '../inconterms/terms-of-trade-code';
-import { ImporterOfRecord } from '../importer-records/importer-of-record';
-import { CustomsCharges } from '../customs/customs-charges';
-
-/** @description Basic structure for a customs declaration for manifest */
-export class ManifestCustoms {
-  /** @description Indicates the type of contents associated with this shipment */
-  contents?: CustomsContentTypes;
-  /** @description Indicates what the seller would like done in case of an issue with delivery */
-  non_delivery?: CustomsNonDelivery;
-  /** @description Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper. */
-  buyer_shipping_amount_paid?: Currency;
-  /** @description The amount of duties paid by the shipper, if any. This is generally only necessary for DDP (bill_duties_to_sender) shipments. */
-  duties_paid?: Currency;
-  /** @description Declaration statement to be placed on the commercial invoice */
-  declaration?: string;
-  /** @description Incoterms specify who is responsible for paying for and managing the shipment*/
-  terms_of_trade_code?: TermsOfTradeCode;
-  /** @description The owner or purchaser of the products being imported into a destination country.*/
-  importer_of_record?: ImporterOfRecord;
-  /** @description The charges related with customs.*/
-  invoice_additional_details?: CustomsCharges;
-  /**@description: text explanation for the content */
-  contents_explanation?: string;
-  /**@description: An EDN is a number which is nine alphanumeric characters long and issued by the Australian Customs (Australian Border Force) in exchange for the information that an exporter shares with them.  */
-  export_declaration_number?: string;
-}
+import {
+  Currency,
+  CustomsContentTypes,
+  CustomsItem,
+  CustomsNonDelivery,
+} from '@shipengine/connect-carrier-api';
+import { TermsOfTradeCode } from '../inconterms/terms-of-trade-code';
+import { ImporterOfRecord } from '../importer-records/importer-of-record';
+import { CustomsCharges } from '../customs/customs-charges';
+
+/** @description Basic structure for a customs declaration for manifest */
+export class ManifestCustoms {
+  /** @description Indicates the type of contents associated with this shipment */
+  contents?: CustomsContentTypes;
+  /** @description Indicates what the seller would like done in case of an issue with delivery */
+  non_delivery?: CustomsNonDelivery;
+  /** @description Indicates how much the buyer paid for shipping, if any. This amount may be different than the shipping cost billed to the shipper. */
+  buyer_shipping_amount_paid?: Currency;
+  /** @description The amount of duties paid by the shipper, if any. This is generally only necessary for DDP (bill_duties_to_sender) shipments. */
+  duties_paid?: Currency;
+  /** @description Declaration statement to be placed on the commercial invoice */
+  declaration?: string;
+  /** @description Incoterms specify who is responsible for paying for and managing the shipment*/
+  terms_of_trade_code?: TermsOfTradeCode;
+  /** @description The owner or purchaser of the products being imported into a destination country.*/
+  importer_of_record?: ImporterOfRecord;
+  /** @description The charges related with customs.*/
+  invoice_additional_details?: CustomsCharges;
+  /**@description: text explanation for the content */
+  contents_explanation?: string;
+  /**@description: An EDN is a number which is nine alphanumeric characters long and issued by the Australian Customs (Australian Border Force) in exchange for the information that an exporter shares with them.  */
+  export_declaration_number?: string;
+}

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

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-
-export const ManifestErrorSchema = Joi.object({
-  manifest_request_shipment_ids: Joi.array().required(),
-  message: Joi.string().optional(),
-});
+import Joi from 'joi';
+
+export const ManifestErrorSchema = Joi.object({
+  manifest_request_shipment_ids: Joi.array().required(),
+  message: Joi.string().optional(),
+});

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

@@ -1,4 +1,4 @@
-export interface ManifestError {
-  manifest_request_shipment_ids: string[];
-  message: string;
-}
+export interface ManifestError {
+  manifest_request_shipment_ids: string[];
+  message: string;
+}

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

@@ -1,8 +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;
-  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;
+}