@shipengine/connect-carrier-api 2.12.18 → 4.0.0-beta

package/lib/models/labels/label-message-schema.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LabelMessageSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+exports.LabelMessageSchema = joi_1.default.object({
+    reference1: joi_1.default.string().optional(),
+    reference2: joi_1.default.string().optional(),
+    reference3: joi_1.default.string().optional(),
+});
+//# sourceMappingURL=label-message-schema.js.map

package/lib/models/labels/label-message-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"label-message-schema.js","sourceRoot":"","sources":["../../../src/models/labels/label-message-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAET,QAAA,kBAAkB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3C,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACpC,CAAC,CAAC"}

package/lib/models/pickup/shipped-package-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const ShippedPackageSchema: Joi.ObjectSchema<any>;

package/lib/models/pickup/shipped-package-schema.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShippedPackageSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const identifier_schema_1 = require("../identifier-schema");
+const units_1 = require("../units");
+const currency_schema_1 = require("../currency-schema");
+const dimension_details_schema_1 = require("../units/dimension-details-schema");
+const weight_details_schema_1 = require("../units/weight-details-schema");
+const label_message_schema_1 = require("../labels/label-message-schema");
+const customs_schema_1 = require("../customs/customs-schema");
+exports.ShippedPackageSchema = joi_1.default.object({
+    tracking_number: joi_1.default.string().optional(),
+    alternative_identifiers: joi_1.default.array().items(identifier_schema_1.IdentifierSchema).optional(),
+    dimension_details: dimension_details_schema_1.DimensionDetailsSchema.optional(),
+    weight_details: weight_details_schema_1.WeightDetailsSchema.optional(),
+    package_code: joi_1.default.string().optional(),
+    weight: joi_1.default.number().optional(),
+    dimensions: units_1.DimensionsSchema.optional(),
+    insured_value: currency_schema_1.CurrencySchema.required(),
+    label_messages: label_message_schema_1.LabelMessageSchema.optional(),
+    customs: customs_schema_1.CustomsSchema.optional(),
+});
+//# sourceMappingURL=shipped-package-schema.js.map

package/lib/models/pickup/shipped-package-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipped-package-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-package-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,4DAAwD;AACxD,oCAA4C;AAC5C,wDAAoD;AACpD,gFAA2E;AAC3E,0EAAqE;AACrE,yEAAoE;AACpE,8DAA0D;AAE7C,QAAA,oBAAoB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC7C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,uBAAuB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,oCAAgB,CAAC,CAAC,QAAQ,EAAE;IACvE,iBAAiB,EAAE,iDAAsB,CAAC,QAAQ,EAAE;IACpD,cAAc,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IAC9C,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,wBAAgB,CAAC,QAAQ,EAAE;IACvC,aAAa,EAAE,gCAAc,CAAC,QAAQ,EAAE;IACxC,cAAc,EAAE,yCAAkB,CAAC,QAAQ,EAAE;IAC7C,OAAO,EAAE,8BAAa,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC"}

package/lib/models/pickup/shipped-shipment-schema.d.ts

@@ -0,0 +1,3 @@
+import Joi from 'joi';
+export declare const ShippedShipmentSchema: Joi.ObjectSchema<any>;
+export declare const PickupShipment: Joi.ObjectSchema<any>;

package/lib/models/pickup/shipped-shipment-schema.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PickupShipment = exports.ShippedShipmentSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const models_1 = require("../../models");
+const ship_to_schema_1 = require("../addresses/ship-to-schema");
+const shipped_package_schema_1 = require("./shipped-package-schema");
+const advanced_options_schema_1 = require("../advanced-options-schema");
+const pudo_location_schema_1 = require("../addresses/pudo-location-schema");
+exports.ShippedShipmentSchema = joi_1.default.object({
+    tracking_number: joi_1.default.string().optional(),
+    ship_to: ship_to_schema_1.ShipToSchema.optional(),
+    alternative_identifiers: joi_1.default.array().items(models_1.IdentifierSchema).optional(),
+    service_code: joi_1.default.string().optional(),
+    packages: joi_1.default.array().items(shipped_package_schema_1.ShippedPackageSchema).optional(),
+    advanced_options: advanced_options_schema_1.AdvancedOptionsSchema.optional(),
+    pickup_location: pudo_location_schema_1.PudoLocationSchema.optional(),
+});
+exports.PickupShipment = exports.ShippedShipmentSchema;
+//# sourceMappingURL=shipped-shipment-schema.js.map

package/lib/models/pickup/shipped-shipment-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipped-shipment-schema.js","sourceRoot":"","sources":["../../../src/models/pickup/shipped-shipment-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,yCAAgD;AAChD,gEAA2D;AAC3D,qEAAgE;AAChE,wEAAmE;AACnE,4EAAuE;AAE1D,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,OAAO,EAAE,6BAAY,CAAC,QAAQ,EAAE;IAChC,uBAAuB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,yBAAgB,CAAC,CAAC,QAAQ,EAAE;IACvE,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,6CAAoB,CAAC,CAAC,QAAQ,EAAE;IAC5D,gBAAgB,EAAE,+CAAqB,CAAC,QAAQ,EAAE;IAClD,eAAe,EAAE,yCAAkB,CAAC,QAAQ,EAAE;CAC/C,CAAC,CAAC;AAEU,QAAA,cAAc,GAAG,6BAAqB,CAAC"}

package/lib/models/taxes/tax-identifier-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const TaxIdentifierSchema: Joi.ObjectSchema<any>;

package/lib/models/taxes/tax-identifier-schema.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaxIdentifierSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const tax_identifier_type_schema_1 = require("./tax-identifier-type-schema");
+exports.TaxIdentifierSchema = joi_1.default.object({
+    id: joi_1.default.string(),
+    type: tax_identifier_type_schema_1.TaxIdentifierTypeSchema,
+    registration_county: joi_1.default.string().optional(),
+    description: joi_1.default.string().optional(),
+});
+//# sourceMappingURL=tax-identifier-schema.js.map

package/lib/models/taxes/tax-identifier-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax-identifier-schema.js","sourceRoot":"","sources":["../../../src/models/taxes/tax-identifier-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,6EAAuE;AAE1D,QAAA,mBAAmB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC5C,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,oDAAuB;IAC7B,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5C,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC"}

package/lib/models/taxes/tax-identifier-type-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const TaxIdentifierTypeSchema: Joi.StringSchema;

package/lib/models/taxes/tax-identifier-type-schema.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaxIdentifierTypeSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const tax_identifier_type_1 = require("./tax-identifier-type");
+exports.TaxIdentifierTypeSchema = joi_1.default.string().valid(...Object.values(tax_identifier_type_1.TaxIdentifierType));
+//# sourceMappingURL=tax-identifier-type-schema.js.map

package/lib/models/taxes/tax-identifier-type-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tax-identifier-type-schema.js","sourceRoot":"","sources":["../../../src/models/taxes/tax-identifier-type-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,+DAA0D;AAE7C,QAAA,uBAAuB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,uCAAiB,CAAC,CAAC,CAAC"}

package/lib/models/units/dimension-details-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const DimensionDetailsSchema: Joi.ObjectSchema<any>;

package/lib/models/units/dimension-details-schema.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DimensionDetailsSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const dimensions_schema_1 = require("./dimensions-schema");
+const dimension_unit_schema_1 = require("./dimension-unit-schema");
+exports.DimensionDetailsSchema = joi_1.default.object({
+    dimensions_in_centimeters: dimensions_schema_1.DimensionsSchema.optional(),
+    dimensions_in_inches: dimensions_schema_1.DimensionsSchema.optional(),
+    source_dimensions: dimensions_schema_1.DimensionsSchema.optional(),
+    source_dimension_unit: dimension_unit_schema_1.DimensionUnitSchema.required(),
+});
+//# sourceMappingURL=dimension-details-schema.js.map

package/lib/models/units/dimension-details-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dimension-details-schema.js","sourceRoot":"","sources":["../../../src/models/units/dimension-details-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,2DAAuD;AACvD,mEAA8D;AAEjD,QAAA,sBAAsB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC/C,yBAAyB,EAAE,oCAAgB,CAAC,QAAQ,EAAE;IACtD,oBAAoB,EAAE,oCAAgB,CAAC,QAAQ,EAAE;IACjD,iBAAiB,EAAE,oCAAgB,CAAC,QAAQ,EAAE;IAC9C,qBAAqB,EAAE,2CAAmB,CAAC,QAAQ,EAAE;CACtD,CAAC,CAAC"}

package/lib/models/units/dimension-unit-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const DimensionUnitSchema: Joi.StringSchema;

package/lib/models/units/dimension-unit-schema.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DimensionUnitSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const dimension_unit_1 = require("./dimension-unit");
+exports.DimensionUnitSchema = joi_1.default.string().valid(...Object.values(dimension_unit_1.DimensionUnit));
+//# sourceMappingURL=dimension-unit-schema.js.map

package/lib/models/units/dimension-unit-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dimension-unit-schema.js","sourceRoot":"","sources":["../../../src/models/units/dimension-unit-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,qDAAiD;AAEpC,QAAA,mBAAmB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,8BAAa,CAAC,CAAC,CAAC"}

package/lib/models/units/weight-details-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const WeightDetailsSchema: Joi.ObjectSchema<any>;

package/lib/models/units/weight-details-schema.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WeightDetailsSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const weight_unit_schema_1 = require("./weight-unit-schema");
+exports.WeightDetailsSchema = joi_1.default.object({
+    weight_in_ounces: joi_1.default.number().optional,
+    weight_in_grams: joi_1.default.number().optional,
+    source_weight: joi_1.default.number().optional,
+    source_weight_unit: weight_unit_schema_1.WeightUnitSchema.required(),
+});
+//# sourceMappingURL=weight-details-schema.js.map

package/lib/models/units/weight-details-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"weight-details-schema.js","sourceRoot":"","sources":["../../../src/models/units/weight-details-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,6DAAwD;AAE3C,QAAA,mBAAmB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC5C,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ;IACvC,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ;IACtC,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ;IACpC,kBAAkB,EAAE,qCAAgB,CAAC,QAAQ,EAAE;CAChD,CAAC,CAAC"}

package/lib/models/units/weight-unit-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const WeightUnitSchema: Joi.StringSchema;

package/lib/models/units/weight-unit-schema.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WeightUnitSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const weight_unit_1 = require("./weight-unit");
+exports.WeightUnitSchema = joi_1.default.string().valid(...Object.values(weight_unit_1.WeightUnit));
+//# sourceMappingURL=weight-unit-schema.js.map

package/lib/models/units/weight-unit-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"weight-unit-schema.js","sourceRoot":"","sources":["../../../src/models/units/weight-unit-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,+CAA2C;AAE9B,QAAA,gBAAgB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,wBAAU,CAAC,CAAC,CAAC"}

package/lib/requests/base-request-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const BaseRequestSchema: Joi.ObjectSchema<any>;

package/lib/requests/base-request-schema.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseRequestSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const authorization_schema_1 = require("../models/authorization-schema");
+exports.BaseRequestSchema = joi_1.default.object({
+    transaction_id: joi_1.default.string().required(),
+    authorization: authorization_schema_1.AuthorizationSchema.optional(),
+    metadata: joi_1.default.object().pattern(/.*/, [joi_1.default.any()]).optional(),
+});
+//# sourceMappingURL=base-request-schema.js.map

package/lib/requests/base-request-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-request-schema.js","sourceRoot":"","sources":["../../src/requests/base-request-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,yEAAqE;AAExD,QAAA,iBAAiB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC1C,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,aAAa,EAAE,0CAAmB,CAAC,QAAQ,EAAE;IAC7C,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,aAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC7D,CAAC,CAAC"}

package/lib/requests/cancel-notification-request-schema.d.ts

@@ -0,0 +1,2 @@
+import Joi from 'joi';
+export declare const CancelNotificationRequestSchema: Joi.ObjectSchema<any>;

package/lib/requests/cancel-notification-request-schema.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CancelNotificationRequestSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const base_request_schema_1 = require("./base-request-schema");
+const shipped_shipment_schema_1 = require("../models/pickup/shipped-shipment-schema");
+exports.CancelNotificationRequestSchema = base_request_schema_1.BaseRequestSchema.keys({
+    notification_id: joi_1.default.string().required(),
+    shipment_information: shipped_shipment_schema_1.ShippedShipmentSchema.required(),
+});
+//# sourceMappingURL=cancel-notification-request-schema.js.map

package/lib/requests/cancel-notification-request-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cancel-notification-request-schema.js","sourceRoot":"","sources":["../../src/requests/cancel-notification-request-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,+DAA0D;AAC1D,sFAAiF;AAEpE,QAAA,+BAA+B,GAAG,uCAAiB,CAAC,IAAI,CAAC;IACpE,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,oBAAoB,EAAE,+CAAqB,CAAC,QAAQ,EAAE;CACvD,CAAC,CAAC"}

package/lib/requests/create-label-request.d.ts

@@ -1,5 +1,5 @@
 import { BaseRequest } from './base-request';
-import { AdvancedOptions, ConfirmationTypes, FulfillmentPlanDetails, InsuranceProviders, DocumentFormat, LabelLayouts, Package, ReturnLabelDetails, ShipFrom, PudoLocation, ShipFromDisplay, ShipTo, Document, TimeWindow, RelayPointDetails, DisplayScheme, Customs, BillTo } from '../models';
+import { AdvancedOptions, ConfirmationTypes, FulfillmentPlanDetails, InsuranceProviders, DocumentFormat, LabelLayouts, Package, ReturnLabelDetails, ShipFrom, PudoLocation, ShipFromDisplay, ShipTo, Document, TimeWindow, RelayPointDetails, DisplayScheme, Customs } from '../models';
 /** @description Basic structure for a request to create a label */
 export declare class CreateLabelRequest extends BaseRequest {
     service_code?: string;
@@ -35,6 +35,4 @@ export declare class CreateLabelRequest extends BaseRequest {
     /** @description Display schemes that the label will be returned in. Label is returned by default */
     display_schemes?: DisplayScheme[];
     customs?: Customs;
-    /** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */
-    bill_shipping_to?: BillTo;
 }

package/lib/requests/create-label-request.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-label-request.js","sourceRoot":"","sources":["../../src/requests/create-label-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAsB7C,mEAAmE;AACnE,MAAa,kBAAmB,SAAQ,0BAAW;CAoClD;AApCD,gDAoCC"}
+{"version":3,"file":"create-label-request.js","sourceRoot":"","sources":["../../src/requests/create-label-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAqB7C,mEAAmE;AACnE,MAAa,kBAAmB,SAAQ,0BAAW;CAkClD;AAlCD,gDAkCC"}

package/lib/requests/get-rates-request.d.ts

@@ -1,5 +1,5 @@
 import { BaseRequest } from './base-request';
-import { ConfirmationTypes, AdvancedOptions, InsuranceProviders, Package, Customs, ShipFrom, ShipTo, PudoLocation, FulfillmentPlanDetails, TimeWindow, BillTo } from '../models';
+import { ConfirmationTypes, AdvancedOptions, InsuranceProviders, Package, Customs, ShipFrom, ShipTo, PudoLocation, FulfillmentPlanDetails, TimeWindow } from '../models';
 import { ShipmentItem } from '../models/shipment-item';
 /** @description Basic structure for a request to get rates */
 export declare class GetRatesRequest extends BaseRequest {
@@ -21,6 +21,4 @@ export declare class GetRatesRequest extends BaseRequest {
     carrier_pickup_window?: TimeWindow;
     /** Items included in the shipment */
     items?: ShipmentItem[];
-    /** @description Bill the shipping charges to this entity. If null, it should be assumed the "shipper" is responsible for the shipping charges. */
-    bill_shipping_to?: BillTo;
 }

package/lib/requests/get-rates-request.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-rates-request.js","sourceRoot":"","sources":["../../src/requests/get-rates-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAgB7C,8DAA8D;AAC9D,MAAa,eAAgB,SAAQ,0BAAW;CAqB/C;AArBD,0CAqBC"}
+{"version":3,"file":"get-rates-request.js","sourceRoot":"","sources":["../../src/requests/get-rates-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAe7C,8DAA8D;AAC9D,MAAa,eAAgB,SAAQ,0BAAW;CAmB/C;AAnBD,0CAmBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "2.12.18",
+  "version": "4.0.0-beta",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://github.com/ShipEngine/connect",
   "main": "./lib/index.js",
@@ -44,7 +44,7 @@
     "tslib": "^2.5.0"
   },
   "peerDependencies": {
-    "@shipengine/connect-runtime": "^1.3.3",
+    "@shipengine/connect-runtime": "^4.0.0-beta",
     "express": "^4.18.2",
     "winston": "^3.8.2"
   }

package/spec.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Shipping API",
     "description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
-    "version": "1.17.2"
+    "version": "1.17.1"
   },
   "paths": {
     "/Register": {
@@ -754,13 +754,6 @@
             },
             "description": "Amount to be paid to the driver, used for local delivery and courier services.",
             "nullable": true
-          },
-          "additional_handling": {
-            "type": "boolean",
-            "description": "Describes whether Additional Handling is requested for the shipment."
-          },
-          "collect_on_delivery": {
-            "$ref": "#/components/schemas/CollectOnDelivery"
           }
         },
         "additionalProperties": { },
@@ -1092,47 +1085,6 @@
         "additionalProperties": false,
         "description": "This model represents a response for a successful cancel pickup request."
       },
-      "CodPaymentType": {
-        "enum": [
-          "any",
-          "cash",
-          "guaranteed_funds"
-        ],
-        "type": "string",
-        "description": "Specifies which payment method is permitted when Collect on Delivery (COD) is requested on a shipment.\r\nany - Any payment method is permitted.\r\ncash - Only cash is permitted.\r\nguaranteed_funds - Only guaranteed funds are permitted, such as a money order or cashier's check."
-      },
-      "CollectOnDelivery": {
-        "required": [
-          "payment_amount"
-        ],
-        "type": "object",
-        "properties": {
-          "payment_amount": {
-            "required": [
-              "currency",
-              "amount"
-            ],
-            "type": "object",
-            "properties": {
-              "amount": {
-                "type": "string",
-                "description": "Decimal currency value, as a string."
-              },
-              "currency": {
-                "type": "string",
-                "description": "Alpha-3 currency code complying with ISO 4217."
-              }
-            },
-            "description": "The payment amount for Collect on Delivery (COD).",
-            "nullable": true
-          },
-          "payment_type": {
-            "$ref": "#/components/schemas/CodPaymentType"
-          }
-        },
-        "additionalProperties": false,
-        "description": "This model represents the option to defer payment for a shipment, otherwise known as Collect on Delivery (COD)."
-      },
       "ConfirmationTypes": {
         "enum": [
           "None",

package/src/app/build-app-deployment.ts

@@ -0,0 +1,50 @@
+import { existsSync } from 'fs';
+import { CarrierAppDefinition } from './carrier-app-definition';
+import { CarrierAppMetadataSchema } from './metadata';
+import { isDataValidationError, validateRatingData } from './native-rating-data-validator';
+import { AppDeployment } from '@shipengine/connect-runtime';
+
+// This creates an object that is only used by the Connect CLI
+export const buildAppDeployment = (definition: CarrierAppDefinition): AppDeployment => {
+  return {
+    id: definition.Metadata.Id,
+    getSupportedCountries: () => {
+      const countries: (string | undefined)[] = [];
+      const rootCountries = definition.Metadata.Carriers.flatMap((c) =>
+        c.DefaultSupportedCountries?.flatMap((sc) => sc.FromCountry),
+      );
+      const serviceCountries = definition.Metadata.Carriers.flatMap((c) =>
+        c.ShippingServices?.flatMap((s) => s.SupportedCountries).flatMap((sc) => sc?.FromCountry),
+      );
+      countries.push(...rootCountries);
+      countries.push(...serviceCountries);
+      return [...new Set(countries)].filter((c) => c !== undefined) as string[];
+    },
+    validate: () => {
+      const results = CarrierAppMetadataSchema.validate(definition.Metadata, {
+        allowUnknown: true,
+        abortEarly: false,
+      });
+      if (results.error) {
+        return results.error.details.map((detail) => `${detail.message}`);
+      }
+
+      const nativeRatingCarriers = definition.Metadata.Carriers.filter(
+        (carrier) =>
+          carrier.NativeRating &&
+          carrier.NativeRating.Path &&
+          existsSync(carrier.NativeRating.Path),
+      );
+
+      const validationErrors = nativeRatingCarriers
+        .map(validateRatingData)
+        .filter(isDataValidationError)
+        .flat();
+      if (validationErrors.length > 0) {
+        return validationErrors.map(
+          (error) => `${error.message} \n Duplicate Keys: ${error.duplicateKeys?.join(', ')}`,
+        );
+      }
+    },
+  };
+};

package/src/app/create-endpoint-mapping.ts

@@ -0,0 +1,25 @@
+import { Method } from '@shipengine/connect-runtime';
+import { ApiEndpoints } from './constants';
+import { CarrierAppDefinition } from './carrier-app-definition';
+
+export const createEndpointMapping = (
+  definition: CarrierAppDefinition,
+): [Method, ApiEndpoints, ((req: any) => any | Promise<any>) | undefined][] => [
+  [Method.POST, ApiEndpoints.CancelNotification, definition.CancelNotification],
+  [Method.POST, ApiEndpoints.CancelPickup, definition.CancelPickup],
+  [Method.POST, ApiEndpoints.CreateLabel, definition.CreateLabel],
+  [Method.POST, ApiEndpoints.CreateManifest, definition.CreateManifest],
+  [Method.POST, ApiEndpoints.GetManifest, definition.GetManifest],
+  [Method.POST, ApiEndpoints.CreateNotification, definition.CreateNotification],
+  [Method.POST, ApiEndpoints.GetRates, definition.GetRates],
+  [Method.POST, ApiEndpoints.NormalizeTrackingData, definition.NormalizeTrackingData],
+  [Method.POST, ApiEndpoints.Register, definition.Register],
+  [Method.POST, ApiEndpoints.SchedulePickup, definition.SchedulePickup],
+  [Method.POST, ApiEndpoints.Track, definition.Track],
+  [Method.POST, ApiEndpoints.ValidateInboundData, definition.ValidateInboundData],
+  [Method.POST, ApiEndpoints.VoidLabels, definition.VoidLabels],
+  [Method.POST, ApiEndpoints.GetRelayPoints, definition.GetRelayPoints],
+  [Method.POST, ApiEndpoints.GetServicePoints, definition.GetServicePoints],
+  [Method.POST, ApiEndpoints.GetServicePoint, definition.GetServicePoint],
+  [Method.POST, ApiEndpoints.ImportTrackingEvents, definition.ImportTrackingEvents],
+];

package/src/app/index.ts

@@ -1,4 +1,6 @@
+export * from './build-app-deployment';
+export * from './constants';
 export * from './metadata';
 export * from './carrier-app-definition';
-export * from './carrier-app';
-export * from './native-rating';
+export * from './create-endpoint-mapping';
+export * from './native-rating-data-validator';

package/src/app/metadata/index.ts

@@ -12,7 +12,9 @@ export * from './function';
 export * from './label-formats';
 export * from './label-sizes';
 export * from './monoauth';
+export * from './native-rating-configuration';
 export * from './package-type';
+export * from './rate-card';
 export * from './service-class';
 export * from './service-grade';
 export * from './service-required-properties';

package/src/app/{native-rating/data-validator.ts → native-rating-data-validator.ts}

@@ -1,6 +1,6 @@
-import { Carrier } from '../metadata/carrier';
 import { resolve } from 'path';
 import { existsSync, readFileSync } from 'fs';
+import { Carrier } from './metadata/carrier';
 
 interface DataValidationError {
   message?: string;

package/src/models/addresses/address-base-schema.ts

@@ -0,0 +1,20 @@
+import Joi from 'joi';
+import { AddressResidentialIndicatorSchema } from './address-residential-indicator-schema';
+
+export const AddressBaseSchema = Joi.object({
+  name: Joi.string().optional(),
+  first_name: Joi.string().optional(),
+  last_name: Joi.string().optional(),
+  email: Joi.string().optional(),
+  phone_number: Joi.string().optional(),
+  company_name: Joi.string().optional(),
+  address_lines: Joi.array().items(Joi.string()).optional(),
+  city_locality: Joi.string().optional(),
+  state_province: Joi.string().optional(),
+  postal_code: Joi.string(),
+  country_code: Joi.string(),
+  address_residential_indicator: AddressResidentialIndicatorSchema.optional(),
+  is_eu: Joi.boolean().optional(),
+  address_metadata: Joi.object().pattern(/.*/, [Joi.string()]).optional(),
+  instructions: Joi.string().optional(),
+});

package/src/models/addresses/address-residential-indicator-schema.ts

@@ -0,0 +1,6 @@
+import Joi from 'joi';
+import { AddressResidentialIndicator } from './address-residential-indicator';
+
+export const AddressResidentialIndicatorSchema = Joi.string().valid(
+  ...Object.values(AddressResidentialIndicator),
+);

package/src/models/addresses/pudo-location-schema.ts

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+import { AddressBaseSchema } from './address-base-schema';
+
+export const PudoLocationSchema = AddressBaseSchema.keys({
+  carrier_code: Joi.string().optional(),
+  location_id: Joi.string().optional(),
+});

package/src/models/addresses/ship-to-schema.ts

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+import { AddressBaseSchema } from './address-base-schema';
+import { TaxIdentifierSchema } from '../taxes/tax-identifier-schema';
+
+export const ShipToSchema = AddressBaseSchema.keys({
+  tax_identifiers: Joi.array().items(TaxIdentifierSchema).optional(),
+});

package/src/models/advanced-options-schema.ts

@@ -0,0 +1,11 @@
+import Joi from 'joi';
+import { CurrencySchema } from './currency-schema';
+
+export const AdvancedOptionsSchema = Joi.object({
+  contains_alcohol: Joi.boolean().optional(),
+  no_postage: Joi.boolean().optional(),
+  nonmachineable: Joi.boolean().optional(),
+  bill_duties_to_sender: Joi.boolean().optional(),
+  saturday_delivery: Joi.boolean().optional(),
+  tip: CurrencySchema.optional(),
+}).pattern(/.*/, Joi.any());

package/src/models/advanced-options.ts

@@ -1,4 +1,3 @@
-import { CollectOnDelivery } from './collect-on-delivery';
 import { Currency } from './currency';
 
 /** @description Basic structure for shipping options */
@@ -15,10 +14,6 @@ export class AdvancedOptions {
   saturday_delivery?: boolean;
   /** @description Amount to be paid to the driver, used for local delivery and courier services */
   tip?: Currency;
-  /** @description Describes whether Additional Handling is requested for the shipment  */
-  additional_handling?: boolean;
-  /** @description Describes details for Collect on Delivery (COD) if requested for the shipment */
-  collect_on_delivery?: CollectOnDelivery;
   /** @description Any other custom shipping options */
   [key: string]: any;
 }

package/src/models/authorization-schema.ts

@@ -0,0 +1,6 @@
+import Joi from 'joi';
+
+export const AuthorizationSchema = Joi.object({
+  access_token: Joi.string().optional(),
+  connection_context: Joi.object().optional(),
+});

package/src/models/billing/index.ts

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

package/src/models/customs/customs-charges-schema.ts

@@ -0,0 +1,9 @@
+import Joi from 'joi';
+import { CurrencySchema } from '../currency-schema';
+
+export const CustomsChargesSchema = Joi.object({
+  freight_charge: CurrencySchema.optional(),
+  other_charge: CurrencySchema.optional(),
+  insurance_charge: CurrencySchema.optional(),
+  discount: CurrencySchema.optional(),
+});

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

@@ -0,0 +1,4 @@
+import Joi from 'joi';
+import { CustomsContentTypes } from './customs-content-types';
+
+export const CustomsContentTypesSchema = Joi.string().valid(...Object.values(CustomsContentTypes));

package/src/models/customs/customs-item-schema.ts

@@ -0,0 +1,17 @@
+import Joi from 'joi';
+import { CurrencySchema } from '../currency-schema';
+import { WeightDetailsSchema } from '../units/weight-details-schema';
+
+export const CustomsItemSchema = Joi.object({
+  description: Joi.string().optional(),
+  quantity: Joi.number().optional(),
+  value: CurrencySchema.optional(),
+  country_of_origin: Joi.string().optional(),
+  harmonized_tariff_code: Joi.string().optional(),
+  sku: Joi.string().optional(),
+  sku_description: Joi.string().optional(),
+  item_weight: WeightDetailsSchema.optional(),
+  product_url: Joi.string().optional(),
+  vat_rate: Joi.number().optional(),
+  mid_code: Joi.string().optional(),
+});

package/src/models/customs/customs-non-delivery-schema.ts

@@ -0,0 +1,4 @@
+import Joi from 'joi';
+import { CustomsNonDelivery } from './customs-non-delivery';
+
+export const CustomsNonDeliverySchema = Joi.string().valid(...Object.values(CustomsNonDelivery));