@shipengine/connect-carrier-api 2.3.0 → 2.3.5

package/src/app/metadata/shipping-service.ts

@@ -1,12 +1,6 @@
 import { ConfirmationType, ConfirmationTypeSchema } from './confirmation-type';
-import {
-  CountryAssociation,
-  CountryAssociationSchema,
-} from './country-association';
-import {
-  ServiceAttributesEnum,
-  ServiceAttributesEnumSchema,
-} from './services-attributes';
+import { CountryAssociation, CountryAssociationSchema } from './country-association';
+import { ServiceAttributesEnum, ServiceAttributesEnumSchema } from './services-attributes';
 import { LabelSizesEnum, LabelSizesEnumSchema } from './label-sizes';
 import { ServiceClassEnum, ServiceClassEnumSchema } from './service-class';
 import { ServiceGradeEnum, ServiceGradeEnumSchema } from './service-grade';
@@ -35,23 +29,11 @@ export interface ShippingService {
 }
 
 export const ShippingServiceSchema = Joi.object({
-  ConfirmationTypes: Joi.array()
-    .optional()
-    .items(ConfirmationTypeSchema)
-    .unique('Type'),
+  ConfirmationTypes: Joi.array().optional().items(ConfirmationTypeSchema).unique('Type'),
   ServiceAttributes: Joi.array().items(ServiceAttributesEnumSchema).optional(),
-  SupportedCountries: Joi.array()
-    .optional()
-    .items(CountryAssociationSchema)
-    .unique('FromCountry'),
-  SupportedLabelSizes: Joi.array()
-    .optional()
-    .items(LabelSizesEnumSchema)
-    .unique(),
-  RequiredProperties: Joi.array()
-    .optional()
-    .items(ServiceRequiredPropertiesEnumSchema)
-    .unique(),
+  SupportedCountries: Joi.array().optional().items(CountryAssociationSchema).unique('FromCountry'),
+  SupportedLabelSizes: Joi.array().optional().items(LabelSizesEnumSchema).unique(),
+  RequiredProperties: Joi.array().optional().items(ServiceRequiredPropertiesEnumSchema).unique(),
   Grade: ServiceGradeEnumSchema.optional(),
   Class: ServiceClassEnumSchema.optional(),
   LabelCode: Joi.string().optional().max(50),

package/src/index.ts

@@ -6,3 +6,4 @@ export * from './requests';
 export * from './responses';
 export * from './app';
 export * from './models';
+export * from './spec';

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

@@ -26,6 +26,4 @@ export enum BillingCategories {
   Tip = 'tip',
 }
 
-export const BillingCategoriesSchema = Joi.string().valid(
-  ...Object.values(BillingCategories),
-);
+export const BillingCategoriesSchema = Joi.string().valid(...Object.values(BillingCategories));

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

@@ -1,7 +1,4 @@
-import {
-  BillingCategories,
-  BillingCategoriesSchema,
-} from './billing-categories';
+import { BillingCategories, BillingCategoriesSchema } from './billing-categories';
 import { Currency, CurrencySchema } from '../currency';
 import Joi from 'joi';
 

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

@@ -12,6 +12,4 @@ export enum DocumentType {
   BillOfLading = 'bill_of_lading',
 }
 
-export const DocumentTypeSchema = Joi.string().valid(
-  ...Object.values(DocumentType),
-);
+export const DocumentTypeSchema = Joi.string().valid(...Object.values(DocumentType));

package/src/models/documents/document.ts

@@ -1,8 +1,5 @@
 import { DocumentType, DocumentTypeSchema } from './document-type';
-import {
-  DocumentFormat,
-  DocumentFormatSchema,
-} from '../labels/document-formats';
+import { DocumentFormat, DocumentFormatSchema } from '../labels/document-formats';
 import Joi from 'joi';
 
 /** @description Basic structure for a document */

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

@@ -6,6 +6,4 @@ export enum DocumentFormat {
   Zpl = 'ZPL',
   Png = 'PNG',
 }
-export const DocumentFormatSchema = Joi.string().valid(
-  ...Object.values(DocumentFormat),
-);
+export const DocumentFormatSchema = Joi.string().valid(...Object.values(DocumentFormat));

package/src/models/manifest-status.ts

@@ -0,0 +1,11 @@
+import Joi from 'joi';
+
+/** @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',
+}
+export const ManifestStatusSchema = Joi.string().valid(...Object.values(ManifestStatus));

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

@@ -1,9 +1,6 @@
 import Joi from 'joi';
 import { Identifier, IdentifierSchema } from '../identifier';
-import {
-  ShipmentIdentifier,
-  ShipmentIdentifierSchema,
-} from './shipment-identifier';
+import { ShipmentIdentifier, ShipmentIdentifierSchema } from './shipment-identifier';
 
 /** @description Basic structure for a pickup confirmation */
 export class PickupConfirmation {

package/src/models/rates/rate.ts

@@ -1,8 +1,5 @@
 import Joi from 'joi';
-import {
-  BillingLineItem,
-  BillingLineItemSchema,
-} from '../billing/billing-line-item';
+import { BillingLineItem, BillingLineItemSchema } from '../billing/billing-line-item';
 import { TimeWindow, TimeWindowSchema } from '../time-window';
 
 /** @description Basic structure for a rate */

package/src/models/tracking/update-method.ts

@@ -8,6 +8,4 @@ export enum UpdateMethods {
   Replace = 'replace',
 }
 
-export const UpdateMethodsSchema = Joi.string().valid(
-  ...Object.values(UpdateMethods),
-);
+export const UpdateMethodsSchema = Joi.string().valid(...Object.values(UpdateMethods));

package/src/requests/get-manifest-request.ts

@@ -0,0 +1,13 @@
+import { BaseRequest } from './base-request';
+
+/** @description Basic structure for a request to get previousely created manifests */
+export class GetManifestRequest extends BaseRequest {
+  // Identifier to retrieve manifest
+  manifest_request_id?: number;
+
+  // Data required to retrieve manifests
+  manifest_identifiers?: { [key: string]: any };
+
+  // Default false: Allow up to 5 checks to DHL before returning.
+  return_immediately?: boolean;
+}

package/src/requests/index.ts

@@ -1,6 +1,7 @@
 export * from './cancel-pickup-request';
 export * from './create-label-request';
 export * from './create-manifest-request';
+export * from './get-manifest-request';
 export * from './get-rates-request';
 export * from './register-request';
 export * from './schedule-pickup-request';

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

@@ -1,14 +1,25 @@
 import { BaseResponse, BaseResponseSchema } from './base-response';
 import { Manifest, ManifestSchema } from '../models';
 import Joi from 'joi';
+import { ManifestStatus, ManifestStatusSchema } from '../models/manifest-status';
 
 /** @description Basic structure for a response to create a manifest */
 export class CreateManifestResponse extends BaseResponse {
   transaction_id!: string;
   manifests?: Manifest[];
+  manifest_request_id?: number;
+  manifest_status?: ManifestStatus;
+  total_shipments?: number;
+  total_invalid?: number;
+  manifest_identifiers?: any;
 }
 
 export const CreateManifestResponseSchema = BaseResponseSchema.keys({
   transaction_id: Joi.string().required(),
   manifests: Joi.array().optional().items(ManifestSchema),
+  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/normalize-tracking-data-response.ts

@@ -1,10 +1,5 @@
 import { BaseResponse, BaseResponseSchema } from './base-response';
-import {
-  UpdateMethods,
-  TrackingInfo,
-  TrackingInfoSchema,
-  UpdateMethodsSchema,
-} from '../models';
+import { UpdateMethods, TrackingInfo, TrackingInfoSchema, UpdateMethodsSchema } from '../models';
 import Joi from 'joi';
 
 /** @description Basic structure for a response to normalize inbound tracking data */

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

@@ -1,8 +1,5 @@
 import { BaseResponse, BaseResponseSchema } from './base-response';
-import {
-  InboundDataContentTypes,
-  InboundDataContentTypesSchema,
-} from '../models';
+import { InboundDataContentTypes, InboundDataContentTypesSchema } from '../models';
 import Joi from 'joi';
 
 /** @description Basic structure for a response to validate inbound data */

package/src/spec.test.ts

@@ -0,0 +1,10 @@
+import { OpenApiSpecification } from './spec';
+describe('when importing the open api specification', () => {
+  it('it should load', () => {
+    expect(OpenApiSpecification).toBeDefined();
+  });
+
+  it('it should have the shape of an openapi document', () => {
+    expect(OpenApiSpecification.openapi).toBeDefined();
+  });
+});

package/src/spec.ts

@@ -0,0 +1,2 @@
+const OpenApiSpecification = require('../spec.json');
+export { OpenApiSpecification };