@shipengine/connect-carrier-api 2.11.5 → 2.11.7

package/src/models/units/dimensions.ts

@@ -1,13 +1,6 @@
-import Joi from 'joi';
-
 /** @description Basic structure for dimensions */
 export class Dimensions {
   length?: number;
   width?: number;
   height?: number;
 }
-export const DimensionsSchema = Joi.object({
-  length: Joi.number().optional(),
-  width: Joi.number().optional(),
-  height: Joi.number().optional(),
-});

package/src/models/units/index.ts

@@ -1,5 +1,6 @@
 export * from './dimension-details';
 export * from './dimension-unit';
+export * from './dimensions-schema';
 export * from './dimensions';
 export * from './weight-details';
 export * from './weight-unit';

package/src/responses/base-response-schema.ts

@@ -0,0 +1,6 @@
+import Joi from 'joi';
+
+export const BaseResponseSchema = Joi.object({
+  metadata: Joi.object().pattern(/.*/, [Joi.any()]).optional(),
+  transaction_id: Joi.string().optional(),
+});

package/src/responses/base-response.ts

@@ -1,10 +1,3 @@
-import Joi from 'joi';
-
 export class BaseResponse {
   metadata?: { [key: string]: any };
 }
-
-export const BaseResponseSchema = Joi.object({
-  metadata: Joi.object().pattern(/.*/, [Joi.any()]).optional(),
-  transaction_id: Joi.string().optional(),
-});

package/src/responses/cancel-notification-response-schema.ts

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+import { BaseResponseSchema } from './base-response-schema';
+
+export const CancelNotificationResponseSchema = BaseResponseSchema.keys({
+  message: Joi.string().optional().empty(),
+  errors: Joi.array().optional().items(Joi.string()),
+});

package/src/responses/cancel-notification-response.ts

@@ -1,5 +1,4 @@
-import Joi from 'joi';
-import { BaseResponse, BaseResponseSchema } from './base-response';
+import { BaseResponse } from './base-response';
 
 export class CancelNotificationResponse extends BaseResponse {
   /** @description User facing text describing the cancellation process. May be left blank to present a default value */
@@ -7,8 +6,3 @@ export class CancelNotificationResponse extends BaseResponse {
   /** @description A list of errors preventing this notification from being cancelled. If no errors are returned the void is considered successful. If  any errors are returned the void is considered failed. */
   errors?: string[];
 }
-
-export const CancelNotificationResponseSchema = BaseResponseSchema.keys({
-  message: Joi.string().optional().empty(),
-  errors: Joi.array().optional().items(Joi.string()),
-});

package/src/responses/cancel-pickup-response-schema.ts

@@ -0,0 +1,9 @@
+import Joi from 'joi';
+import { BaseResponseSchema } from './base-response-schema';
+
+export const CancelPickupResponseSchema = BaseResponseSchema.keys({
+  confirmationa_id: Joi.string().optional(),
+  successful: Joi.boolean().required(),
+  status: Joi.string().optional().empty(),
+  custom_properties: Joi.object().pattern(/.*/, [Joi.string()]).optional(),
+});

package/src/responses/cancel-pickup-response.ts

@@ -1,5 +1,4 @@
-import Joi from 'joi';
-import { BaseResponse, BaseResponseSchema } from './base-response';
+import { BaseResponse } from './base-response';
 
 /** @description Basic structure for a response to cancel pickup */
 export class CancelPickupResponse extends BaseResponse {
@@ -8,10 +7,3 @@ export class CancelPickupResponse extends BaseResponse {
   status?: string;
   custom_properties?: { [key: string]: string };
 }
-
-export const CancelPickupResponseSchema = BaseResponseSchema.keys({
-  confirmationa_id: Joi.string().optional(),
-  successful: Joi.boolean().required(),
-  status: Joi.string().optional().empty(),
-  custom_properties: Joi.object().pattern(/.*/, [Joi.string()]).optional(),
-});

package/src/responses/create-label-response-schema.ts

@@ -0,0 +1,28 @@
+import Joi from 'joi';
+import { BaseResponseSchema } from './base-response-schema';
+import { BillingLineItemSchema } from '../models/billing/billing-line-item-schema';
+import { DocumentSchema } from '../models/documents/document-schema';
+import { IdentifierSchema } from '../models/identifier-schema';
+import { FormDownloadSchema } from '../models/labels/form-download-schema';
+import { LabelDownloadSchema } from '../models/labels/label-download-schema';
+import { LabelPackageSchema } from '../models/labels/label-package-schema';
+import { RelayPointDetailsSchema } from '../models/relay-points/relay-point-details-schema';
+import { TimeWindowSchema } from '../models/time-window-schema';
+
+export const CreateLabelResponseSchema = BaseResponseSchema.keys({
+  transaction_id: Joi.string().required(),
+  label_download: LabelDownloadSchema.optional(),
+  form_download: FormDownloadSchema.optional(),
+  documents: Joi.array().optional().items(DocumentSchema),
+  packages: Joi.array().optional().items(LabelPackageSchema),
+  billing_line_items: Joi.array().optional().items(BillingLineItemSchema),
+  tracking_number: Joi.string().optional().empty(),
+  tracking_url: Joi.string().optional().empty(),
+  trackable: Joi.boolean().optional(),
+  alternative_identifiers: Joi.array().optional().items(IdentifierSchema),
+  estimated_delivery_datetime: Joi.string().optional().empty().isoDate(),
+  consolidator_service_code: Joi.string().optional().empty(),
+  carrier_pickup_window: TimeWindowSchema.optional(),
+  delivery_window: TimeWindowSchema.optional(),
+  relay_points: RelayPointDetailsSchema.optional(),
+});

package/src/responses/create-label-response.ts

@@ -1,4 +1,4 @@
-import { BaseResponse, BaseResponseSchema } from './base-response';
+import { BaseResponse } from './base-response';
 import {
   LabelDownload,
   FormDownload,
@@ -8,16 +8,7 @@ import {
   Identifier,
   TimeWindow,
   RelayPointDetails,
-  LabelDownloadSchema,
-  FormDownloadSchema,
-  DocumentSchema,
-  LabelPackageSchema,
-  BillingLineItemSchema,
-  IdentifierSchema,
-  TimeWindowSchema,
-  RelayPointDetailsSchema,
 } from '../models';
-import Joi from 'joi';
 
 /** @description Basic structure for a response to create a label */
 export class CreateLabelResponse extends BaseResponse {
@@ -39,21 +30,3 @@ export class CreateLabelResponse extends BaseResponse {
   delivery_window?: TimeWindow;
   relay_points?: RelayPointDetails;
 }
-
-export const CreateLabelResponseSchema = BaseResponseSchema.keys({
-  transaction_id: Joi.string().required(),
-  label_download: LabelDownloadSchema.optional(),
-  form_download: FormDownloadSchema.optional(),
-  documents: Joi.array().optional().items(DocumentSchema),
-  packages: Joi.array().optional().items(LabelPackageSchema),
-  billing_line_items: Joi.array().optional().items(BillingLineItemSchema),
-  tracking_number: Joi.string().optional().empty(),
-  tracking_url: Joi.string().optional().empty(),
-  trackable: Joi.boolean().optional(),
-  alternative_identifiers: Joi.array().optional().items(IdentifierSchema),
-  estimated_delivery_datetime: Joi.string().optional().empty().isoDate(),
-  consolidator_service_code: Joi.string().optional().empty(),
-  carrier_pickup_window: TimeWindowSchema.optional(),
-  delivery_window: TimeWindowSchema.optional(),
-  relay_points: RelayPointDetailsSchema.optional(),
-});

package/src/responses/create-manifest-response-schema.ts

@@ -0,0 +1,16 @@
+import Joi from 'joi';
+import { BaseResponseSchema } from './base-response-schema';
+import { ManifestStatusSchema } from '../models/manifest-status-schema';
+import { ManifestErrorSchema } from '../models/manifests/manifest-error-schema';
+import { ManifestSchema } from '../models/manifests/manifest-schema';
+
+export const CreateManifestResponseSchema = BaseResponseSchema.keys({
+  transaction_id: Joi.string().required(),
+  manifests: Joi.array().optional().items(ManifestSchema),
+  errors: ManifestErrorSchema.optional(),
+  manifest_request_id: Joi.number().optional(),
+  manifest_status: ManifestStatusSchema.optional,
+  total_shipments: Joi.number().optional(),
+  total_invalid: Joi.number().optional(),
+  manifest_identifiers: Joi.any().optional(),
+});

package/src/responses/create-manifest-response.ts

@@ -1,7 +1,6 @@
-import { BaseResponse, BaseResponseSchema } from './base-response';
-import { Manifest, ManifestSchema, ManifestError, ManifestErrorSchema } from '../models';
-import Joi from 'joi';
-import { ManifestStatus, ManifestStatusSchema } from '../models/manifest-status';
+import { BaseResponse } from './base-response';
+import { Manifest, ManifestError } from '../models';
+import { ManifestStatus } from '../models/manifest-status';
 
 /** @description Basic structure for a response to create a manifest */
 export class CreateManifestResponse extends BaseResponse {
@@ -14,14 +13,3 @@ export class CreateManifestResponse extends BaseResponse {
   total_invalid?: number;
   manifest_identifiers?: any;
 }
-
-export const CreateManifestResponseSchema = BaseResponseSchema.keys({
-  transaction_id: Joi.string().required(),
-  manifests: Joi.array().optional().items(ManifestSchema),
-  errors: ManifestErrorSchema.optional(),
-  manifest_request_id: Joi.number().optional(),
-  manifest_status: ManifestStatusSchema.optional,
-  total_shipments: Joi.number().optional(),
-  total_invalid: Joi.number().optional(),
-  manifest_identifiers: Joi.any().optional(),
-});

package/src/responses/create-notification-response-schema.ts

@@ -0,0 +1,8 @@
+import Joi from 'joi';
+import { BillingLineItemSchema } from '../models/billing/billing-line-item-schema';
+import { BaseResponseSchema } from './base-response-schema';
+
+export const CreateNotificationResponseSchema = BaseResponseSchema.keys({
+  notification_id: Joi.string().required(),
+  billing_line_items: Joi.array().optional().items(BillingLineItemSchema),
+});

package/src/responses/create-notification-response.ts

@@ -1,14 +1,8 @@
-import Joi from 'joi';
-import { BillingLineItem, BillingLineItemSchema } from '../models';
-import { BaseResponse, BaseResponseSchema } from './base-response';
+import { BillingLineItem } from '../models';
+import { BaseResponse } from './base-response';
 
 export class CreateNotificationResponse extends BaseResponse {
   /** @description The id of the sucessfully created notification*/
   notification_id!: string;
   billing_line_items?: BillingLineItem[];
 }
-
-export const CreateNotificationResponseSchema = BaseResponseSchema.keys({
-  notification_id: Joi.string().required(),
-  billing_line_items: Joi.array().optional().items(BillingLineItemSchema),
-});

package/src/responses/get-rates-response-schema.ts

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+import { RateSchema } from '../models/rates/rate-schema';
+import { BaseResponseSchema } from './base-response-schema';
+
+export const GetRatesResponseSchema = BaseResponseSchema.keys({
+  rates: Joi.array().required().items(RateSchema),
+});

package/src/responses/get-rates-response.ts

@@ -1,12 +1,7 @@
-import { BaseResponse, BaseResponseSchema } from './base-response';
-import { Rate, RateSchema } from '../models';
-import Joi from 'joi';
+import { BaseResponse } from './base-response';
+import { Rate } from '../models';
 
 /** @description Basic structure for a response to get rates */
 export class GetRatesResponse extends BaseResponse {
   rates!: Rate[];
 }
-
-export const GetRatesResponseSchema = BaseResponseSchema.keys({
-  rates: Joi.array().required().items(RateSchema),
-});

package/src/responses/get-relay-points-response-schema.ts

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+import { RelayPointSchema } from '../models/relay-points/relay-point-schema';
+import { BaseResponseSchema } from './base-response-schema';
+
+export const GetRelayPointsResponseSchema = BaseResponseSchema.keys({
+  relay_points: Joi.array().required().items(RelayPointSchema),
+});

package/src/responses/get-relay-points-response.ts

@@ -1,12 +1,7 @@
-import { BaseResponse, BaseResponseSchema } from './base-response';
-import { RelayPoint, RelayPointSchema } from '../models';
-import Joi from 'joi';
+import { BaseResponse } from './base-response';
+import { RelayPoint } from '../models';
 
 /** @description Basic structure for a response to create a label */
 export class GetRelayPointsResponse extends BaseResponse {
   relay_points!: RelayPoint[];
 }
-
-export const GetRelayPointsResponseSchema = BaseResponseSchema.keys({
-  relay_points: Joi.array().required().items(RelayPointSchema),
-});

package/src/responses/get-service-point-response-schema.ts

@@ -0,0 +1,6 @@
+import { ServicePointSchema } from '../models/service-points/service-point-schema';
+import { BaseResponseSchema } from './base-response-schema';
+
+export const GetServicePointResponseSchema = BaseResponseSchema.keys({
+  service_point: ServicePointSchema.required(),
+});

package/src/responses/get-service-point-response.ts

@@ -1,12 +1,8 @@
-import { BaseResponse, BaseResponseSchema } from './base-response';
-import { ServicePoint, ServicePointSchema } from '../models/service-points';
+import { BaseResponse } from './base-response';
+import { ServicePoint } from '../models/service-points';
 
 /** @description Basic structure for a response to get a single service point by id */
 export class GetServicePointResponse extends BaseResponse {
   /** @description The resulting service point */
   service_point!: ServicePoint;
 }
-
-export const GetServicePointResponseSchema = BaseResponseSchema.keys({
-  service_point: ServicePointSchema.required(),
-});

package/src/responses/get-service-points-response-schema.ts

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+import { ServicePointSchema } from '../models/service-points/service-point-schema';
+import { BaseResponseSchema } from './base-response-schema';
+
+export const GetServicePointsResponseSchema = BaseResponseSchema.keys({
+  service_points: Joi.array().required().items(ServicePointSchema),
+});

package/src/responses/get-service-points-response.ts

@@ -1,13 +1,8 @@
-import { BaseResponse, BaseResponseSchema } from './base-response';
-import Joi from 'joi';
-import { ServicePoint, ServicePointSchema } from '../models/service-points';
+import { BaseResponse } from './base-response';
+import { ServicePoint } from '../models/service-points';
 
 /** @description Basic structure for a response to get service points */
 export class GetServicePointsResponse extends BaseResponse {
   /** @description The resulting service points */
   service_points!: ServicePoint[];
 }
-
-export const GetServicePointsResponseSchema = BaseResponseSchema.keys({
-  service_points: Joi.array().required().items(ServicePointSchema),
-});

package/src/responses/index.ts

@@ -1,16 +1,31 @@
+export * from './cancel-notification-response-schema';
+export * from './cancel-notification-response';
+export * from './cancel-pickup-response-schema';
 export * from './cancel-pickup-response';
+export * from './create-label-response-schema';
 export * from './create-label-response';
+export * from './create-manifest-response-schema';
 export * from './create-manifest-response';
+export * from './create-notification-response-schema';
+export * from './create-notification-response';
+export * from './error-response';
+export * from './get-rates-response-schema';
 export * from './get-rates-response';
+export * from './get-relay-points-response-schema';
+export * from './get-relay-points-response';
+export * from './get-service-point-response-schema';
+export * from './get-service-point-response';
+export * from './get-service-points-response-schema';
+export * from './get-service-points-response';
+export * from './normalize-tracking-data-response-schema';
+export * from './normalize-tracking-data-response';
+export * from './register-response-schema';
 export * from './register-response';
+export * from './schedule-pickup-response-schema';
 export * from './schedule-pickup-response';
+export * from './tracking-response-schema';
 export * from './tracking-response';
-export * from './void-labels-response';
-export * from './error-response';
-export * from './cancel-notification-response';
-export * from './create-notification-response';
+export * from './validate-inbound-data-response-schema';
 export * from './validate-inbound-data-response';
-export * from './normalize-tracking-data-response';
-export * from './get-relay-points-response';
-export * from './get-service-points-response';
-export * from './get-service-point-response';
+export * from './void-labels-response-schema';
+export * from './void-labels-response';

package/src/responses/normalize-tracking-data-response-schema.ts

@@ -0,0 +1,9 @@
+import Joi from 'joi';
+import { TrackingInfoSchema } from '../models/tracking/tracking-info-schema';
+import { UpdateMethodsSchema } from '../models/tracking/update-method-schema';
+import { BaseResponseSchema } from './base-response-schema';
+
+export const NormalizeTrackingDataResponseSchema = BaseResponseSchema.keys({
+  tracking_info: Joi.array().required().items(TrackingInfoSchema),
+  update_method: UpdateMethodsSchema,
+});

package/src/responses/normalize-tracking-data-response.ts

@@ -1,6 +1,5 @@
-import { BaseResponse, BaseResponseSchema } from './base-response';
-import { UpdateMethods, TrackingInfo, TrackingInfoSchema, UpdateMethodsSchema } from '../models';
-import Joi from 'joi';
+import { BaseResponse } from './base-response';
+import { UpdateMethods, TrackingInfo } from '../models';
 
 /** @description Basic structure for a response to normalize inbound tracking data */
 export class NormalizeTrackingDataResponse extends BaseResponse {
@@ -12,8 +11,3 @@ export class NormalizeTrackingDataResponse extends BaseResponse {
    */
   update_method!: UpdateMethods;
 }
-
-export const NormalizeTrackingDataResponseSchema = BaseResponseSchema.keys({
-  tracking_info: Joi.array().required().items(TrackingInfoSchema),
-  update_method: UpdateMethodsSchema,
-});

package/src/responses/register-response-schema.ts

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+import { CredentialsSchema } from '../models/registration/credentials-schema';
+
+export const RegisterResponseSchema = Joi.object({
+  credentials: CredentialsSchema.required(),
+  metadata: Joi.object().pattern(/.*/, [Joi.any()]).required(),
+});

package/src/responses/register-response.ts

@@ -1,12 +1,7 @@
-import Joi from 'joi';
-import { Credentials, CredentialsSchema } from '../models';
+import { Credentials } from '../models';
 
 /** @description Basic structure for a response to register/connect */
 export class RegisterResponse {
   credentials!: Credentials;
   metadata!: object;
 }
-export const RegisterResponseSchema = Joi.object({
-  credentials: CredentialsSchema.required(),
-  metadata: Joi.object().pattern(/.*/, [Joi.any()]).required(),
-});

package/src/responses/schedule-pickup-response-schema.ts

@@ -0,0 +1,13 @@
+import Joi from 'joi';
+import { BillingLineItemSchema } from '../models/billing/billing-line-item-schema';
+import { PickupConfirmationSchema } from '../models/pickup/pickup-confirmation-schema';
+import { PickupWindowSchema } from '../models/pickup/pickup-window-schema';
+import { BaseResponseSchema } from './base-response-schema';
+
+export const SchedulePickupResponseSchema = BaseResponseSchema.keys({
+  confirmation: PickupConfirmationSchema.optional(),
+  pickup_windows: Joi.array().optional().items(PickupWindowSchema),
+  remarks: Joi.string().optional().empty(),
+  custom_properties: Joi.object().pattern(/.*/, [Joi.string()]).optional(),
+  billing_line_items: Joi.array().optional().items(BillingLineItemSchema),
+});

package/src/responses/schedule-pickup-response.ts

@@ -1,13 +1,5 @@
-import { BaseResponse, BaseResponseSchema } from './base-response';
-import {
-  PickupConfirmation,
-  PickupWindow,
-  BillingLineItem,
-  PickupConfirmationSchema,
-  PickupWindowSchema,
-  BillingLineItemSchema,
-} from '../models';
-import Joi from 'joi';
+import { BaseResponse } from './base-response';
+import { PickupConfirmation, PickupWindow, BillingLineItem } from '../models';
 
 /** @description Basic structure for a response to schedule a pickup */
 export class SchedulePickupResponse extends BaseResponse {
@@ -17,11 +9,3 @@ export class SchedulePickupResponse extends BaseResponse {
   custom_properties?: { [key: string]: string };
   billing_line_items?: BillingLineItem[];
 }
-
-export const SchedulePickupResponseSchema = BaseResponseSchema.keys({
-  confirmation: PickupConfirmationSchema.optional(),
-  pickup_windows: Joi.array().optional().items(PickupWindowSchema),
-  remarks: Joi.string().optional().empty(),
-  custom_properties: Joi.object().pattern(/.*/, [Joi.string()]).optional(),
-  billing_line_items: Joi.array().optional().items(BillingLineItemSchema),
-});

package/src/responses/tests/validation-test.test.ts

@@ -1,8 +1,8 @@
 import Joi from 'joi';
 import { describe, expect, it } from 'vitest';
 import { StandardizedStatusCodes, TrackingInfo } from '../../models';
-import { CreateManifestResponseSchema } from '../create-manifest-response';
-import { TrackingResponseSchema } from '../tracking-response';
+import { CreateManifestResponseSchema } from '../create-manifest-response-schema';
+import { TrackingResponseSchema } from '../tracking-response-schema';
 
 const tracking_info: TrackingInfo = {
   standardized_status_code: StandardizedStatusCodes.Unknown,

package/src/responses/tracking-response-schema.ts

@@ -0,0 +1,6 @@
+import { TrackingInfoSchema } from '../models/tracking/tracking-info-schema';
+import { BaseResponseSchema } from './base-response-schema';
+
+export const TrackingResponseSchema = BaseResponseSchema.keys({
+  tracking_info: TrackingInfoSchema.required(),
+});

package/src/responses/tracking-response.ts

@@ -1,11 +1,7 @@
-import { BaseResponse, BaseResponseSchema } from './base-response';
-import { TrackingInfo, TrackingInfoSchema } from '../models';
+import { BaseResponse } from './base-response';
+import { TrackingInfo } from '../models';
 
 /** @description Basic structure for a response to get tracking information */
 export class TrackingResponse extends BaseResponse {
   tracking_info!: TrackingInfo;
 }
-
-export const TrackingResponseSchema = BaseResponseSchema.keys({
-  tracking_info: TrackingInfoSchema.required(),
-});

package/src/responses/validate-inbound-data-response-schema.ts

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+import { InboundDataContentTypesSchema } from '../models/inbound-content-types-schema';
+import { BaseResponseSchema } from './base-response-schema';
+
+export const ValidateInboundDataResponseSchema = BaseResponseSchema.keys({
+  content_types: Joi.array().required().items(InboundDataContentTypesSchema),
+});

package/src/responses/validate-inbound-data-response.ts

@@ -1,13 +1,8 @@
-import { BaseResponse, BaseResponseSchema } from './base-response';
-import { InboundDataContentTypes, InboundDataContentTypesSchema } from '../models';
-import Joi from 'joi';
+import { BaseResponse } from './base-response';
+import { InboundDataContentTypes } from '../models';
 
 /** @description Basic structure for a response to validate inbound data */
 export class ValidateInboundDataResponse extends BaseResponse {
   /** @description List of content types included in the data */
   content_types!: InboundDataContentTypes[];
 }
-
-export const ValidateInboundDataResponseSchema = BaseResponseSchema.keys({
-  content_types: Joi.array().required().items(InboundDataContentTypesSchema),
-});

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

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+import { VoidResponseSchema } from '../models/labels/void-response-schema';
+import { BaseResponseSchema } from './base-response-schema';
+
+export const VoidLabelsResponseSchema = BaseResponseSchema.keys({
+  void_responses: Joi.array().required().items(VoidResponseSchema),
+});

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

@@ -1,13 +1,8 @@
-import { BaseResponse, BaseResponseSchema } from './base-response';
-import { VoidResponse, VoidResponseSchema } from '../models';
-import Joi from 'joi';
+import { BaseResponse } from './base-response';
+import { VoidResponse } from '../models';
 
 /** @description Basic structure for a response to void labels */
 export class VoidLabelsResponse extends BaseResponse {
   /** @description List of void responses*/
   void_responses!: VoidResponse[];
 }
-
-export const VoidLabelsResponseSchema = BaseResponseSchema.keys({
-  void_responses: Joi.array().required().items(VoidResponseSchema),
-});