@shipengine/connect-carrier-api 2.11.5 → 2.11.7

package/src/app/create-get-rates-handler.ts

@@ -77,7 +77,19 @@ const createNativeRatingHandler = (carrier: Carrier) => {
       }
 
       const results = await rateShipments(req);
-      return results.find((x) => x.id === 'rate-request');
+      const rateResult = results.find((x) => x.id === 'rate-request');
+      if (!rateResult) {
+        throw new Error(
+          `Could not find rate for request 'rate-request'. Ensure you return the request id with your rates.`,
+        );
+      }
+
+      return {
+        rates: rateResult.rates,
+        metadata: {
+          error: rateResult.error,
+        },
+      };
     };
   } catch (err: any) {
     console.warn(err?.message);

package/src/app/metadata/carrier.ts

@@ -8,7 +8,10 @@ import { LabelFormatsEnum, LabelFormatsEnumSchema } from './label-formats';
 import { LabelSizesEnum, LabelSizesEnumSchema } from './label-sizes';
 import { ConfirmationDictionary, ConfirmationDictionarySchema } from './confirmation-type';
 import Joi from 'joi';
-import { NativeRatingConfiguration } from './native-rating-configuration';
+import {
+  NativeRatingConfiguration,
+  NativeRatingConfigurationSchema,
+} from './native-rating-configuration';
 import { fileExists } from './custom-validators/file-exists';
 
 import { ApiCodeRegex, ApiCodeValidationMessage } from '@shipengine/connect-runtime';
@@ -97,6 +100,7 @@ export const CarrierSchema = Joi.object({
       .pattern(new RegExp('^.*.(svg)$'))
       .message('Images.Logo must be a svg file.'),
   }).required(),
+  NativeRating: NativeRatingConfigurationSchema.optional(),
   DocumentTemplate: Joi.string()
     .optional()
     .custom(fileExists, 'template exists')

package/src/app/native-rating/base-rate-context.ts

@@ -64,8 +64,12 @@ export const createContextBuilder = (basePath: string) => {
   };
 
   const log = winston.createLogger({
-    format: format.combine(format.colorize(), format.timestamp(), format.metadata()),
-    transports: [new transports.Console({ level: 'debug' })],
+    transports: [
+      new transports.Console({
+        level: 'debug',
+        format: format.combine(format.colorize(), format.timestamp(), format.metadata()),
+      }),
+    ],
   });
 
   return (rateCard: RateCard): RatingContext => {

package/src/models/billing/billing-categories-schema.ts

@@ -0,0 +1,4 @@
+import Joi from 'joi';
+import { BillingCategories } from './billing-categories';
+
+export const BillingCategoriesSchema = Joi.string().valid(...Object.values(BillingCategories));

package/src/models/billing/billing-categories.ts

@@ -1,5 +1,3 @@
-import Joi from 'joi';
-
 /** @description Category for a billing line item */
 export enum BillingCategories {
   Uncategorized = 'uncategorized',
@@ -25,5 +23,3 @@ export enum BillingCategories {
   /** @description Amount to be paid to the driver, used for local delivery and courier services */
   Tip = 'tip',
 }
-
-export const BillingCategoriesSchema = Joi.string().valid(...Object.values(BillingCategories));

package/src/models/billing/billing-line-item-schema.ts

@@ -0,0 +1,12 @@
+import { BillingCategoriesSchema } from './billing-categories-schema';
+import { CurrencySchema } from '../currency-schema';
+import Joi from 'joi';
+
+export const BillingLineItemSchema = Joi.object({
+  billing_category: BillingCategoriesSchema.required(),
+  carrier_description: Joi.string().optional().empty().max(100),
+  carrier_billing_code: Joi.string().optional().empty(),
+  memo: Joi.string().optional().empty().max(250),
+  amount: CurrencySchema.required(),
+  provider_billed_amount: CurrencySchema.optional(),
+});

package/src/models/billing/billing-line-item.ts

@@ -1,6 +1,5 @@
-import { BillingCategories, BillingCategoriesSchema } from './billing-categories';
-import { Currency, CurrencySchema } from '../currency';
-import Joi from 'joi';
+import { BillingCategories } from './billing-categories';
+import { Currency } from '../currency';
 
 /** @description Basic structure of each charge or line item */
 export class BillingLineItem {
@@ -17,12 +16,3 @@ export class BillingLineItem {
   /** @description Total amount of the line item billed by the provider. This should only be populated if it differs from 'amount' **/
   provider_billed_amount?: Currency;
 }
-
-export const BillingLineItemSchema = Joi.object({
-  billing_category: BillingCategoriesSchema.required(),
-  carrier_description: Joi.string().optional().empty().max(100),
-  carrier_billing_code: Joi.string().optional().empty(),
-  memo: Joi.string().optional().empty().max(250),
-  amount: CurrencySchema.required(),
-  provider_billed_amount: CurrencySchema.optional(),
-});

package/src/models/billing/index.ts

@@ -1,2 +1,4 @@
 export * from './billing-categories';
+export * from './billing-categories-schema';
 export * from './billing-line-item';
+export * from './billing-line-item-schema';

package/src/models/currency-schema.ts

@@ -0,0 +1,6 @@
+import Joi from 'joi';
+
+export const CurrencySchema = Joi.object({
+  currency: Joi.string().required(),
+  amount: Joi.string().required(),
+});

package/src/models/currency.ts

@@ -1,5 +1,3 @@
-import Joi from 'joi';
-
 /** @description Basic structure for defining an amount of money and its currency */
 export class Currency {
   /** @description The ISO 4217 Currency Code (USD, EUR, etc) https://www.iso.org/iso-4217-currency-codes.html */
@@ -7,8 +5,3 @@ export class Currency {
   /** @description The amount */
   amount!: string;
 }
-
-export const CurrencySchema = Joi.object({
-  currency: Joi.string().required(),
-  amount: Joi.string().required(),
-});

package/src/models/display-scheme-schema.ts

@@ -0,0 +1,4 @@
+import Joi from 'joi';
+import { DisplayScheme } from './display-scheme';
+
+export const DisplaySchemeSchema = Joi.string().valid(...Object.values(DisplayScheme));

package/src/models/display-scheme.ts

@@ -1,5 +1,3 @@
-import Joi from 'joi';
-
 /** @description The display scheme that the label will be returned in */
 export enum DisplayScheme {
   /** @description Indicates that a shipping label will be returned, default option */
@@ -7,5 +5,3 @@ export enum DisplayScheme {
   /** @description Indicates that a paperless label will be returned if available. For example: a qr code image. */
   PaperlessLabel = 'paperless_label',
 }
-
-export const DisplaySchemeSchema = Joi.string().valid(...Object.values(DisplayScheme));

package/src/models/documents/document-schema.ts

@@ -0,0 +1,9 @@
+import { DocumentTypeSchema } from './document-type-schema';
+import { DocumentFormatSchema } from '../labels/document-formats-schema';
+import Joi from 'joi';
+
+export const DocumentSchema = Joi.object({
+  type: Joi.array().required().min(1).items(DocumentTypeSchema),
+  data: Joi.string().required(),
+  format: DocumentFormatSchema.required(),
+});

package/src/models/documents/document-type-schema.ts

@@ -0,0 +1,4 @@
+import Joi from 'joi';
+import { DocumentType } from './document-type';
+
+export const DocumentTypeSchema = Joi.string().valid(...Object.values(DocumentType));

package/src/models/documents/document-type.ts

@@ -1,5 +1,3 @@
-import Joi from 'joi';
-
 /** @description Types of documents */
 export enum DocumentType {
   /** @description A shipping label */
@@ -13,5 +11,3 @@ export enum DocumentType {
   /** @description A paperless label. For example: a QR code that customers can display on their phone */
   PaperlessLabel = 'paperless_label',
 }
-
-export const DocumentTypeSchema = Joi.string().valid(...Object.values(DocumentType));

package/src/models/documents/document.ts

@@ -1,6 +1,5 @@
-import { DocumentType, DocumentTypeSchema } from './document-type';
-import { DocumentFormat, DocumentFormatSchema } from '../labels/document-formats';
-import Joi from 'joi';
+import { DocumentType } from './document-type';
+import { DocumentFormat } from '../labels/document-formats';
 
 /** @description Basic structure for a document */
 export class Document {
@@ -11,8 +10,3 @@ export class Document {
   /** @description The format the document is in (Pdf, Zpl, etc) */
   format!: DocumentFormat;
 }
-export const DocumentSchema = Joi.object({
-  type: Joi.array().required().min(1).items(DocumentTypeSchema),
-  data: Joi.string().required(),
-  format: DocumentFormatSchema.required(),
-});

package/src/models/documents/index.ts

@@ -1,2 +1,3 @@
 export * from './document';
 export * from './document-type';
+export * from './document-type-schema';

package/src/models/identifier-schema.ts

@@ -0,0 +1,6 @@
+import Joi from 'joi';
+
+export const IdentifierSchema = Joi.object({
+  type: Joi.string().required(),
+  value: Joi.string().required(),
+});

package/src/models/identifier.ts

@@ -1,12 +1,5 @@
-import Joi from 'joi';
-
 /** @description Key value pair to allow custom properties */
 export class Identifier {
   type!: string;
   value!: string;
 }
-
-export const IdentifierSchema = Joi.object({
-  type: Joi.string().required(),
-  value: Joi.string().required(),
-});

package/src/models/inbound-content-types-schema.ts

@@ -0,0 +1,6 @@
+import Joi from 'joi';
+import { InboundDataContentTypes } from './inbound-content-types';
+
+export const InboundDataContentTypesSchema = Joi.string().valid(
+  ...Object.values(InboundDataContentTypes),
+);

package/src/models/inbound-content-types.ts

@@ -1,10 +1,5 @@
-import Joi from 'joi';
-
 /** @description Types of inbound content */
 export enum InboundDataContentTypes {
   /** @description Tracking information */
   Tracking = 'tracking',
 }
-export const InboundDataContentTypesSchema = Joi.string().valid(
-  ...Object.values(InboundDataContentTypes),
-);

package/src/models/index.ts

@@ -1,26 +1,32 @@
 export * from './addresses';
+export * from './advanced-options';
 export * from './authorization';
 export * from './billing';
+export * from './confirmation-types';
+export * from './currency-schema';
+export * from './currency';
 export * from './customs';
+export * from './display-scheme-schema';
+export * from './display-scheme';
+export * from './documents';
 export * from './errors';
 export * from './fulfillment-plans';
+export * from './identifier-schema';
+export * from './identifier';
+export * from './inbound-content-types-schema';
+export * from './inbound-content-types';
+export * from './insurance-providers';
 export * from './labels';
 export * from './manifests';
+export * from './package';
 export * from './pickup';
 export * from './rates';
 export * from './registration';
-export * from './tracking';
-export * from './units';
-export * from './advanced-options';
-export * from './confirmation-types';
-export * from './currency';
-export * from './identifier';
-export * from './insurance-providers';
-export * from './package';
+export * from './relay-points';
+export * from './resource-download-schema';
 export * from './resource-download';
 export * from './taxes';
-export * from './documents';
+export * from './time-window-schema';
 export * from './time-window';
-export * from './inbound-content-types';
-export * from './relay-points';
-export * from './display-scheme';
+export * from './tracking';
+export * from './units';

package/src/models/labels/document-formats-schema.ts

@@ -0,0 +1,4 @@
+import Joi from 'joi';
+import { DocumentFormat } from './document-formats';
+
+export const DocumentFormatSchema = Joi.string().valid(...Object.values(DocumentFormat));

package/src/models/labels/document-formats.ts

@@ -1,9 +1,6 @@
-import Joi from 'joi';
-
 /** @description Label data type */
 export enum DocumentFormat {
   Pdf = 'PDF',
   Zpl = 'ZPL',
   Png = 'PNG',
 }
-export const DocumentFormatSchema = Joi.string().valid(...Object.values(DocumentFormat));

package/src/models/labels/form-download-schema.ts

@@ -0,0 +1,6 @@
+import Joi from 'joi';
+import { ResourceDownloadSchema } from '../resource-download-schema';
+
+export const FormDownloadSchema = ResourceDownloadSchema.keys({
+  form_data: Joi.string().optional().empty(),
+});

package/src/models/labels/form-download.ts

@@ -1,12 +1,7 @@
-import Joi from 'joi';
-import { ResourceDownload, ResourceDownloadSchema } from '../resource-download';
+import { ResourceDownload } from '../resource-download';
 
 /** @description This provides any additional forms that go with the label. For example, customs forms. Exactly one of the keys should be populated. Set href is the forms should be downloaded separately. Set data if the forms are returned directly in the response. */
 export class FormDownload extends ResourceDownload {
   /** @description The base64 encoded resource data. */
   form_data?: string;
 }
-
-export const FormDownloadSchema = ResourceDownloadSchema.keys({
-  form_data: Joi.string().optional().empty(),
-});

package/src/models/labels/index.ts

@@ -1,9 +1,14 @@
-export * from './label-package';
+export * from './document-formats-schema';
+export * from './document-formats';
+export * from './form-download-schema';
 export * from './form-download';
+export * from './label-download-schema';
 export * from './label-download';
-export * from './document-formats';
 export * from './label-layouts';
 export * from './label-message';
+export * from './label-package-schema';
+export * from './label-package';
 export * from './return-label-details';
 export * from './void-request';
+export * from './void-response-schema';
 export * from './void-response';

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

@@ -0,0 +1,6 @@
+import Joi from 'joi';
+import { ResourceDownloadSchema } from '../resource-download-schema';
+
+export const LabelDownloadSchema = ResourceDownloadSchema.keys({
+  label_data: Joi.string().optional().empty(),
+});

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

@@ -1,12 +1,7 @@
-import Joi from 'joi';
-import { ResourceDownload, ResourceDownloadSchema } from '../resource-download';
+import { ResourceDownload } from '../resource-download';
 
 /** @description This object provides the requested label that was just created. Exactly one of the keys should be populated. Set href if the label should be downloaded separately. Set data if the label is returned directly in the response. */
 export class LabelDownload extends ResourceDownload {
   /** @description The base64 encoded resource data. */
   label_data?: string;
 }
-
-export const LabelDownloadSchema = ResourceDownloadSchema.keys({
-  label_data: Joi.string().optional().empty(),
-});

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

@@ -0,0 +1,9 @@
+import Joi from 'joi';
+import { DocumentSchema } from '../documents/document-schema';
+import { IdentifierSchema } from '../identifier-schema';
+
+export const LabelPackageSchema = Joi.object({
+  tracking_number: Joi.string().optional().empty(),
+  alternative_identifiers: Joi.array().optional().items(IdentifierSchema),
+  documents: Joi.array().optional().items(DocumentSchema),
+});

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

@@ -1,6 +1,5 @@
-import { Identifier, IdentifierSchema } from '../identifier';
-import { Document, DocumentSchema } from '../documents';
-import Joi from 'joi';
+import { Identifier } from '../identifier';
+import { Document } from '../documents';
 
 /** @description Package information provided by the carrier */
 export class LabelPackage {
@@ -11,9 +10,3 @@ export class LabelPackage {
   /** @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[];
 }
-
-export const LabelPackageSchema = Joi.object({
-  tracking_number: Joi.string().optional().empty(),
-  alternative_identifiers: Joi.array().optional().items(IdentifierSchema),
-  documents: Joi.array().optional().items(DocumentSchema),
-});

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

@@ -0,0 +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),
+});

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

@@ -1,5 +1,5 @@
-import Joi from 'joi';
-import { BillingLineItem, BillingLineItemSchema } from '../billing';
+import { BillingLineItem } from '../billing';
+
 /** @description Basic structure for a response to void a label */
 export class VoidResponse {
   /** @description Id for the void response */
@@ -11,10 +11,3 @@ export class VoidResponse {
   /** @description Individual Billing Line items which remain after voiding the label, e.g. a cancellation fee */
   billing_line_items?: BillingLineItem[];
 }
-
-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/manifest-status-schema.ts

@@ -0,0 +1,4 @@
+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,5 +1,3 @@
-import Joi from 'joi';
-
 /** @description Possible status values for Created Manifest */
 export enum ManifestStatus {
   /** @description Unknown, The request is in process */
@@ -8,4 +6,3 @@ export enum ManifestStatus {
   Completed = 'completed',
   Failed = 'failed',
 }
-export const ManifestStatusSchema = Joi.string().valid(...Object.values(ManifestStatus));

package/src/models/manifests/index.ts

@@ -1,4 +1,6 @@
 export * from './label';
-export * from './manifest';
-export * from './manifest-request-shipment';
+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/manifest-error-schema.ts

@@ -0,0 +1,6 @@
+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,11 +1,4 @@
-import Joi from 'joi';
-
 export interface ManifestError {
   manifest_request_shipment_ids: string[];
   message: string;
 }
-
-export const ManifestErrorSchema = Joi.object({
-  manifest_request_shipment_ids: Joi.array().required(),
-  message: Joi.string().optional(),
-});

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

@@ -0,0 +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()),
+});

package/src/models/manifests/manifest.ts

@@ -1,5 +1,4 @@
-import Joi from 'joi';
-import { ResourceDownload, ResourceDownloadSchema } from '../resource-download';
+import { ResourceDownload } from '../resource-download';
 
 /** @description This model represents a single manifest created with a shipping provider. */
 export class Manifest {
@@ -13,11 +12,3 @@ export class Manifest {
   document_data?: string;
   manifest_request_shipment_ids?: string[];
 }
-
-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/package.ts

@@ -2,7 +2,6 @@ import { DimensionDetails } from './units/dimension-details';
 import { WeightDetails } from './units/weight-details';
 import { Currency } from './currency';
 import { LabelMessage } from './labels/label-message';
-import { Dimensions } from './units/dimensions';
 import { Customs } from './customs';
 
 /** @description Basic structure for a package */

package/src/models/pickup/index.ts

@@ -1,11 +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 './shipped-shipment';
+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 './pickup-package';
+export * from './shipped-shipment';

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

@@ -0,0 +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),
+});

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

@@ -1,6 +1,5 @@
-import Joi from 'joi';
-import { Identifier, IdentifierSchema } from '../identifier';
-import { ShipmentIdentifier, ShipmentIdentifierSchema } from './shipment-identifier';
+import { Identifier } from '../identifier';
+import { ShipmentIdentifier } from './shipment-identifier';
 
 /** @description Basic structure for a pickup confirmation */
 export class PickupConfirmation {
@@ -11,8 +10,3 @@ export class PickupConfirmation {
   /** @description List of the shipments added for this pickup. */
   shipment_identifiers?: ShipmentIdentifier[];
 }
-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-window-schema.ts

@@ -0,0 +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(),
+});

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

@@ -1,5 +1,3 @@
-import Joi from 'joi';
-
 /** @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 */
@@ -11,9 +9,3 @@ export class PickupWindow {
   /** @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;
 }
-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/shipment-identifier-schema.ts

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

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

@@ -1,5 +1,4 @@
-import Joi from 'joi';
-import { Identifier, IdentifierSchema } from '../identifier';
+import { Identifier } from '../identifier';
 
 /** @description Identifier object for shiments */
 export class ShipmentIdentifier {
@@ -8,8 +7,3 @@ export class ShipmentIdentifier {
   /** @description A list of alternate identifiers that can be used to identify a shipment */
   alternate_identifiers?: Identifier[];
 }
-
-export const ShipmentIdentifierSchema = Joi.object({
-  tracking_number: Joi.string().optional().empty(),
-  alternate_identifiers: Joi.array().optional().items(IdentifierSchema),
-});

package/src/models/rates/index.ts

@@ -1 +1,2 @@
 export * from './rate';
+export * from './rate-schema';