@shipengine/connect-carrier-api 4.29.2 → 4.30.0

package/lib/app/metadata/carrier-app-metadata.d.ts

@@ -9,5 +9,7 @@ export interface CarrierAppMetadata {
     AuthProcess?: AuthSpecification;
     /** @description A list of branded carriers */
     Carriers: Carrier[];
+    /** @description Indicates whether the integration was developed by the carrier themselves (true) or by ShipStation (false) */
+    IsSelfIntegrated?: boolean;
 }
 export declare const CarrierAppMetadataSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/carrier-app-metadata.js

@@ -14,5 +14,6 @@ exports.CarrierAppMetadataSchema = joi_1.default.object({
         .min(1)
         .message('There must be at least 1 Carrier defined')
         .items(_1.CarrierSchema),
+    IsSelfIntegrated: joi_1.default.boolean().strict().optional(),
 });
 //# sourceMappingURL=carrier-app-metadata.js.map

package/lib/app/metadata/carrier-app-metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"carrier-app-metadata.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier-app-metadata.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wBAAuF;AAa1E,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAClC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,0BAAuB,CAAC,QAAQ,EAAE;IAC/C,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE;SAClB,MAAM,CAAC,IAAI,CAAC;SACZ,QAAQ,EAAE;SACV,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,0CAA0C,CAAC;SACnD,KAAK,CAAC,gBAAa,CAAC;CACxB,CAAC,CAAC"}
+{"version":3,"file":"carrier-app-metadata.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier-app-metadata.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wBAAuF;AAe1E,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAClC,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,0BAAuB,CAAC,QAAQ,EAAE;IAC/C,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE;SAClB,MAAM,CAAC,IAAI,CAAC;SACZ,QAAQ,EAAE;SACV,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,0CAA0C,CAAC;SACnD,KAAK,CAAC,gBAAa,CAAC;IACvB,gBAAgB,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACpD,CAAC,CAAC"}

package/lib/app/metadata/enums.d.ts

@@ -56,3 +56,17 @@ export declare enum TrackingSubscriptionLevel {
     TrackingNumber = "TrackingNumber",
     Account = "Account"
 }
+export declare enum ServiceDirection {
+    Outbound = "Outbound",
+    Return = "Return",
+    Both = "Both"
+}
+export declare enum DayOfWeek {
+    MON = "MON",
+    TUE = "TUE",
+    WED = "WED",
+    THU = "THU",
+    FRI = "FRI",
+    SAT = "SAT",
+    SUN = "SUN"
+}

package/lib/app/metadata/enums.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TrackingSubscriptionLevel = exports.RequiredProperty = exports.ServiceGrade = exports.ServiceClass = exports.SupportedLabelSize = exports.ShippingServiceAttribute = exports.CarrierAttribute = void 0;
+exports.DayOfWeek = exports.ServiceDirection = exports.TrackingSubscriptionLevel = exports.RequiredProperty = exports.ServiceGrade = exports.ServiceClass = exports.SupportedLabelSize = exports.ShippingServiceAttribute = exports.CarrierAttribute = void 0;
 var CarrierAttribute;
 (function (CarrierAttribute) {
     CarrierAttribute["ManifestDigital"] = "ManifestDigital";
@@ -66,4 +66,20 @@ var TrackingSubscriptionLevel;
     TrackingSubscriptionLevel["TrackingNumber"] = "TrackingNumber";
     TrackingSubscriptionLevel["Account"] = "Account";
 })(TrackingSubscriptionLevel || (exports.TrackingSubscriptionLevel = TrackingSubscriptionLevel = {}));
+var ServiceDirection;
+(function (ServiceDirection) {
+    ServiceDirection["Outbound"] = "Outbound";
+    ServiceDirection["Return"] = "Return";
+    ServiceDirection["Both"] = "Both";
+})(ServiceDirection || (exports.ServiceDirection = ServiceDirection = {}));
+var DayOfWeek;
+(function (DayOfWeek) {
+    DayOfWeek["MON"] = "MON";
+    DayOfWeek["TUE"] = "TUE";
+    DayOfWeek["WED"] = "WED";
+    DayOfWeek["THU"] = "THU";
+    DayOfWeek["FRI"] = "FRI";
+    DayOfWeek["SAT"] = "SAT";
+    DayOfWeek["SUN"] = "SUN";
+})(DayOfWeek || (exports.DayOfWeek = DayOfWeek = {}));
 //# sourceMappingURL=enums.js.map

package/lib/app/metadata/enums.js.map

@@ -1 +1 @@
-{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/app/metadata/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,uDAAmC,CAAA;IACnC,yDAAqC,CAAA;IACrC,iDAA6B,CAAA;IAC7B,yCAAqB,CAAA;IACrB,qEAAiD,CAAA;IACjD,yDAAqC,CAAA;IACrC,uDAAmC,CAAA;IACnC,2EAAuD,CAAA;IACvD,2EAAuD,CAAA;AACzD,CAAC,EAVW,gBAAgB,gCAAhB,gBAAgB,QAU3B;AAED,IAAY,wBAgBX;AAhBD,WAAY,wBAAwB;IAClC,+CAAmB,CAAA;IACnB,yDAA6B,CAAA;IAC7B,iDAAqB,CAAA;IACrB,uEAA2C,CAAA;IAC3C,iFAAqD,CAAA;IACrD,+DAAmC,CAAA;IACnC,iEAAqC,CAAA;IACrC,6DAAiC,CAAA;IACjC,uCAAW,CAAA;IACX,6DAAiC,CAAA;IACjC,2EAA+C,CAAA;IAC/C,6DAAiC,CAAA;IACjC,6EAAiD,CAAA;IACjD,yFAA6D,CAAA;IAC7D,6EAAiD,CAAA;AACnD,CAAC,EAhBW,wBAAwB,wCAAxB,wBAAwB,QAgBnC;AAED,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,6CAAuB,CAAA;AACzB,CAAC,EAHW,kBAAkB,kCAAlB,kBAAkB,QAG7B;AAED,IAAY,YASX;AATD,WAAY,YAAY;IACtB,2CAA2B,CAAA;IAC3B,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,2CAA2B,CAAA;IAC3B,+CAA+B,CAAA;IAC/B,iCAAiB,CAAA;IACjB,2CAA2B,CAAA;IAC3B,qCAAqB,CAAA;AACvB,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AAED,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,2CAA2B,CAAA;IAC3B,mCAAmB,CAAA;IACnB,uCAAuB,CAAA;IACvB,uCAAuB,CAAA;IACvB,qCAAqB,CAAA;AACvB,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AAED,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,6CAAyB,CAAA;AAC3B,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B;AAED,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACnC,0CAAa,CAAA;IACb,8DAAiC,CAAA;IACjC,gDAAmB,CAAA;AACrB,CAAC,EAJW,yBAAyB,yCAAzB,yBAAyB,QAIpC"}
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/app/metadata/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,uDAAmC,CAAA;IACnC,yDAAqC,CAAA;IACrC,iDAA6B,CAAA;IAC7B,yCAAqB,CAAA;IACrB,qEAAiD,CAAA;IACjD,yDAAqC,CAAA;IACrC,uDAAmC,CAAA;IACnC,2EAAuD,CAAA;IACvD,2EAAuD,CAAA;AACzD,CAAC,EAVW,gBAAgB,gCAAhB,gBAAgB,QAU3B;AAED,IAAY,wBAgBX;AAhBD,WAAY,wBAAwB;IAClC,+CAAmB,CAAA;IACnB,yDAA6B,CAAA;IAC7B,iDAAqB,CAAA;IACrB,uEAA2C,CAAA;IAC3C,iFAAqD,CAAA;IACrD,+DAAmC,CAAA;IACnC,iEAAqC,CAAA;IACrC,6DAAiC,CAAA;IACjC,uCAAW,CAAA;IACX,6DAAiC,CAAA;IACjC,2EAA+C,CAAA;IAC/C,6DAAiC,CAAA;IACjC,6EAAiD,CAAA;IACjD,yFAA6D,CAAA;IAC7D,6EAAiD,CAAA;AACnD,CAAC,EAhBW,wBAAwB,wCAAxB,wBAAwB,QAgBnC;AAED,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,6CAAuB,CAAA;AACzB,CAAC,EAHW,kBAAkB,kCAAlB,kBAAkB,QAG7B;AAED,IAAY,YASX;AATD,WAAY,YAAY;IACtB,2CAA2B,CAAA;IAC3B,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,2CAA2B,CAAA;IAC3B,+CAA+B,CAAA;IAC/B,iCAAiB,CAAA;IACjB,2CAA2B,CAAA;IAC3B,qCAAqB,CAAA;AACvB,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AAED,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,2CAA2B,CAAA;IAC3B,mCAAmB,CAAA;IACnB,uCAAuB,CAAA;IACvB,uCAAuB,CAAA;IACvB,qCAAqB,CAAA;AACvB,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AAED,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,6CAAyB,CAAA;AAC3B,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B;AAED,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACnC,0CAAa,CAAA;IACb,8DAAiC,CAAA;IACjC,gDAAmB,CAAA;AACrB,CAAC,EAJW,yBAAyB,yCAAzB,yBAAyB,QAIpC;AAED,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,yCAAqB,CAAA;IACrB,qCAAiB,CAAA;IACjB,iCAAa,CAAA;AACf,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B;AAED,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,wBAAW,CAAA;IACX,wBAAW,CAAA;IACX,wBAAW,CAAA;IACX,wBAAW,CAAA;IACX,wBAAW,CAAA;IACX,wBAAW,CAAA;AACb,CAAC,EARW,SAAS,yBAAT,SAAS,QAQpB"}

package/lib/app/metadata/index.d.ts

@@ -25,3 +25,5 @@ export * from './shipping-service';
 export * from './zone';
 export * from './connection-names-configuration';
 export * from './account-connection-specification';
+export * from './transit';
+export * from './package-constraints';

package/lib/app/metadata/index.js

@@ -28,4 +28,6 @@ tslib_1.__exportStar(require("./shipping-service"), exports);
 tslib_1.__exportStar(require("./zone"), exports);
 tslib_1.__exportStar(require("./connection-names-configuration"), exports);
 tslib_1.__exportStar(require("./account-connection-specification"), exports);
+tslib_1.__exportStar(require("./transit"), exports);
+tslib_1.__exportStar(require("./package-constraints"), exports);
 //# sourceMappingURL=index.js.map

package/lib/app/metadata/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/app/metadata/index.ts"],"names":[],"mappings":";;;AAAA,2DAAiC;AACjC,4DAAkC;AAClC,+DAAqC;AACrC,oDAA0B;AAC1B,iEAAuC;AACvC,+DAAqC;AACrC,8DAAoC;AACpC,gEAAsC;AACtC,8DAAoC;AACpC,kDAAwB;AACxB,qDAA2B;AAC3B,0DAAgC;AAChC,wDAA8B;AAC9B,qDAA2B;AAC3B,wEAA8C;AAC9C,yDAA+B;AAC/B,sDAA4B;AAC5B,0DAAgC;AAChC,0DAAgC;AAChC,wEAA8C;AAC9C,gEAAsC;AACtC,4DAAkC;AAClC,wEAA8C;AAC9C,6DAAmC;AACnC,iDAAuB;AACvB,2EAAiD;AACjD,6EAAmD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/app/metadata/index.ts"],"names":[],"mappings":";;;AAAA,2DAAiC;AACjC,4DAAkC;AAClC,+DAAqC;AACrC,oDAA0B;AAC1B,iEAAuC;AACvC,+DAAqC;AACrC,8DAAoC;AACpC,gEAAsC;AACtC,8DAAoC;AACpC,kDAAwB;AACxB,qDAA2B;AAC3B,0DAAgC;AAChC,wDAA8B;AAC9B,qDAA2B;AAC3B,wEAA8C;AAC9C,yDAA+B;AAC/B,sDAA4B;AAC5B,0DAAgC;AAChC,0DAAgC;AAChC,wEAA8C;AAC9C,gEAAsC;AACtC,4DAAkC;AAClC,wEAA8C;AAC9C,6DAAmC;AACnC,iDAAuB;AACvB,2EAAiD;AACjD,6EAAmD;AACnD,oDAA0B;AAC1B,gEAAsC"}

package/lib/app/metadata/package-constraints.d.ts

@@ -0,0 +1,13 @@
+import Joi from 'joi';
+/** @description Package size and weight constraints for a shipping service */
+export interface PackageConstraints {
+    /** @description Minimum package dimensions in LxWxH format (cm), e.g. "10x10x1" */
+    MinDimensions?: string | null;
+    /** @description Maximum package dimensions in LxWxH format (cm), e.g. "120x60x60" */
+    MaxDimensions?: string | null;
+    /** @description Minimum package weight in kg */
+    MinWeight?: number | null;
+    /** @description Maximum package weight in kg */
+    MaxWeight?: number | null;
+}
+export declare const PackageConstraintsSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/package-constraints.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackageConstraintsSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+exports.PackageConstraintsSchema = joi_1.default.object({
+    MinDimensions: joi_1.default.string().optional().allow(null),
+    MaxDimensions: joi_1.default.string().optional().allow(null),
+    MinWeight: joi_1.default.number().optional().allow(null),
+    MaxWeight: joi_1.default.number().optional().allow(null),
+});
+//# sourceMappingURL=package-constraints.js.map

package/lib/app/metadata/package-constraints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-constraints.js","sourceRoot":"","sources":["../../../src/app/metadata/package-constraints.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAcT,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;IAClD,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;IAClD,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;IAC9C,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;CAC/C,CAAC,CAAC"}

package/lib/app/metadata/shipping-provider-connector.d.ts

@@ -4,4 +4,6 @@ export interface ShippingProviderConnector {
     Functions: FunctionSpecification[];
     ApiVersion: string;
     DiagnosticRoutes?: DiagnosticRoutes;
+    /** @description Indicates whether the integration was developed by the carrier themselves (true) or by ShipStation (false) */
+    IsSelfIntegrated?: boolean;
 }

package/lib/app/metadata/shipping-service.d.ts

@@ -6,6 +6,9 @@ import { ServiceClassEnum } from './service-class';
 import { ServiceGradeEnum } from './service-grade';
 import { ServiceRequiredPropertiesEnum } from './service-required-properties';
 import Joi from 'joi';
+import { Transit } from './transit';
+import { PackageConstraints } from './package-constraints';
+import { ServiceDirection } from './enums';
 /** @description Basic structure for each shipping service */
 export interface ShippingService {
     /** @description The confirmation types associated with this service */
@@ -36,5 +39,15 @@ export interface ShippingService {
     ApiCode?: string;
     /** @description The unique identifier for this shipping service. It should not change after being published */
     Id: string;
+    /** @description Customer-facing description of service capabilities and features */
+    ServiceDescription?: string;
+    /** @description Direction of this service */
+    ServiceDirection?: ServiceDirection;
+    /** @description List of ISO 3166-1 alpha-2 destination country codes supported by this service */
+    DestinationCountries?: string[];
+    /** @description Transit time and delivery schedule information */
+    Transit?: Transit;
+    /** @description Package size and weight constraints for this service */
+    PackageConstraints?: PackageConstraints;
 }
 export declare const ShippingServiceSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/shipping-service.js

@@ -11,6 +11,10 @@ const service_grade_1 = require("./service-grade");
 const service_required_properties_1 = require("./service-required-properties");
 const joi_1 = tslib_1.__importDefault(require("joi"));
 const connect_runtime_1 = require("@shipengine/connect-runtime");
+const transit_1 = require("./transit");
+const package_constraints_1 = require("./package-constraints");
+const enums_1 = require("./enums");
+const ServiceDirectionSchema = joi_1.default.string().valid(...Object.values(enums_1.ServiceDirection));
 exports.ShippingServiceSchema = joi_1.default.object({
     ConfirmationTypes: joi_1.default.array().optional().items(confirmation_type_1.ConfirmationTypeSchema).unique('Type'),
     ServiceAttributes: joi_1.default.array().items(services_attributes_1.ServiceAttributesEnumSchema).optional(),
@@ -26,5 +30,13 @@ exports.ShippingServiceSchema = joi_1.default.object({
     Name: joi_1.default.string().required().max(80),
     ApiCode: joi_1.default.string().optional().pattern(connect_runtime_1.ApiCodeRegex, connect_runtime_1.ApiCodeValidationMessage),
     Id: joi_1.default.string().uuid().required(),
+    ServiceDescription: joi_1.default.string().optional(),
+    ServiceDirection: ServiceDirectionSchema.optional(),
+    DestinationCountries: joi_1.default.array()
+        .optional()
+        .items(joi_1.default.string().pattern(/^[A-Z]{2}$/))
+        .unique(),
+    Transit: transit_1.TransitSchema.optional(),
+    PackageConstraints: package_constraints_1.PackageConstraintsSchema.optional(),
 });
 //# sourceMappingURL=shipping-service.js.map

package/lib/app/metadata/shipping-service.js.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-service.js","sourceRoot":"","sources":["../../../src/app/metadata/shipping-service.ts"],"names":[],"mappings":";;;;AAAA,2DAA+E;AAC/E,+DAAqF;AACrF,+DAA2F;AAC3F,+CAAqE;AACrE,mDAA2E;AAC3E,mDAA2E;AAC3E,+EAGuC;AACvC,sDAAsB;AAEtB,iEAAqF;AAkCxE,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,0CAAsB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;IACtF,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,iDAA2B,CAAC,CAAC,QAAQ,EAAE;IAC5E,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,8CAAwB,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;IAChG,mBAAmB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,kCAAoB,CAAC,CAAC,MAAM,EAAE;IAChF,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,iEAAmC,CAAC,CAAC,MAAM,EAAE;IAC9F,KAAK,EAAE,sCAAsB,CAAC,QAAQ,EAAE;IACxC,KAAK,EAAE,sCAAsB,CAAC,QAAQ,EAAE;IACxC,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IAC1C,aAAa,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChD,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,8BAAY,EAAE,0CAAwB,CAAC;IAChF,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC"}
+{"version":3,"file":"shipping-service.js","sourceRoot":"","sources":["../../../src/app/metadata/shipping-service.ts"],"names":[],"mappings":";;;;AAAA,2DAA+E;AAC/E,+DAAqF;AACrF,+DAA2F;AAC3F,+CAAqE;AACrE,mDAA2E;AAC3E,mDAA2E;AAC3E,+EAGuC;AACvC,sDAAsB;AAEtB,iEAAqF;AACrF,uCAAmD;AACnD,+DAAqF;AACrF,mCAA2C;AAE3C,MAAM,sBAAsB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,wBAAgB,CAAC,CAAC,CAAC;AA4CzE,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,0CAAsB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;IACtF,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,iDAA2B,CAAC,CAAC,QAAQ,EAAE;IAC5E,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,8CAAwB,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;IAChG,mBAAmB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,kCAAoB,CAAC,CAAC,MAAM,EAAE;IAChF,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,iEAAmC,CAAC,CAAC,MAAM,EAAE;IAC9F,KAAK,EAAE,sCAAsB,CAAC,QAAQ,EAAE;IACxC,KAAK,EAAE,sCAAsB,CAAC,QAAQ,EAAE;IACxC,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IAC1C,aAAa,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChD,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,8BAAY,EAAE,0CAAwB,CAAC;IAChF,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAClC,kBAAkB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3C,gBAAgB,EAAE,sBAAsB,CAAC,QAAQ,EAAE;IACnD,oBAAoB,EAAE,aAAG,CAAC,KAAK,EAAE;SAC9B,QAAQ,EAAE;SACV,KAAK,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;SACzC,MAAM,EAAE;IACX,OAAO,EAAE,uBAAa,CAAC,QAAQ,EAAE;IACjC,kBAAkB,EAAE,8CAAwB,CAAC,QAAQ,EAAE;CACxD,CAAC,CAAC"}

package/lib/app/metadata/transit.d.ts

@@ -0,0 +1,22 @@
+import Joi from 'joi';
+import { DayOfWeek } from './enums';
+/** @description Operational schedule defining collection, trunking and delivery days */
+export interface OperationalSchedule {
+    /** @description Days on which the carrier collects parcels */
+    CollectionDays?: DayOfWeek[];
+    /** @description Days on which the carrier trunks parcels between hubs */
+    TrunkingDays?: DayOfWeek[];
+    /** @description Days on which the carrier delivers parcels */
+    DeliveryDays?: DayOfWeek[];
+}
+export declare const OperationalScheduleSchema: Joi.ObjectSchema<any>;
+/** @description Transit information for a shipping service */
+export interface Transit {
+    /** @description Transit time in days, as a number or range (e.g. "3" or "3-5") */
+    TransitTimeInDays?: string | null;
+    /** @description Latest time of day by which delivery is made (e.g. "17:00") */
+    DeliveryByTime?: string | null;
+    /** @description Operational schedule for collection, trunking and delivery days */
+    OperationalSchedule?: OperationalSchedule;
+}
+export declare const TransitSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/transit.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransitSchema = exports.OperationalScheduleSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const enums_1 = require("./enums");
+const DayOfWeekSchema = joi_1.default.string().valid(...Object.values(enums_1.DayOfWeek));
+exports.OperationalScheduleSchema = joi_1.default.object({
+    CollectionDays: joi_1.default.array().optional().items(DayOfWeekSchema).unique(),
+    TrunkingDays: joi_1.default.array().optional().items(DayOfWeekSchema).unique(),
+    DeliveryDays: joi_1.default.array().optional().items(DayOfWeekSchema).unique(),
+});
+exports.TransitSchema = joi_1.default.object({
+    TransitTimeInDays: joi_1.default.string().optional().allow(null),
+    DeliveryByTime: joi_1.default.string().optional().allow(null),
+    OperationalSchedule: exports.OperationalScheduleSchema.optional(),
+});
+//# sourceMappingURL=transit.js.map

package/lib/app/metadata/transit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transit.js","sourceRoot":"","sources":["../../../src/app/metadata/transit.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,mCAAoC;AAYpC,MAAM,eAAe,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,iBAAS,CAAC,CAAC,CAAC;AAE3D,QAAA,yBAAyB,GAAG,aAAG,CAAC,MAAM,CAAC;IAClD,cAAc,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE;IACtE,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE;IACpE,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE;CACrE,CAAC,CAAC;AAYU,QAAA,aAAa,GAAG,aAAG,CAAC,MAAM,CAAC;IACtC,iBAAiB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;IACtD,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;IACnD,mBAAmB,EAAE,iCAAyB,CAAC,QAAQ,EAAE;CAC1D,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.29.2",
+  "version": "4.30.0",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",

package/src/app/metadata/carrier-app-metadata.ts

@@ -10,6 +10,8 @@ export interface CarrierAppMetadata {
   AuthProcess?: AuthSpecification;
   /** @description A list of branded carriers */
   Carriers: Carrier[];
+  /** @description Indicates whether the integration was developed by the carrier themselves (true) or by ShipStation (false) */
+  IsSelfIntegrated?: boolean;
 }
 
 export const CarrierAppMetadataSchema = Joi.object({
@@ -22,4 +24,5 @@ export const CarrierAppMetadataSchema = Joi.object({
     .min(1)
     .message('There must be at least 1 Carrier defined')
     .items(CarrierSchema),
+  IsSelfIntegrated: Joi.boolean().strict().optional(),
 });

package/src/app/metadata/enums.ts

@@ -62,3 +62,19 @@ export enum TrackingSubscriptionLevel {
   TrackingNumber = 'TrackingNumber',
   Account = 'Account',
 }
+
+export enum ServiceDirection {
+  Outbound = 'Outbound',
+  Return = 'Return',
+  Both = 'Both',
+}
+
+export enum DayOfWeek {
+  MON = 'MON',
+  TUE = 'TUE',
+  WED = 'WED',
+  THU = 'THU',
+  FRI = 'FRI',
+  SAT = 'SAT',
+  SUN = 'SUN',
+}

package/src/app/metadata/index.ts

@@ -25,3 +25,5 @@ export * from './shipping-service';
 export * from './zone';
 export * from './connection-names-configuration';
 export * from './account-connection-specification';
+export * from './transit';
+export * from './package-constraints';

package/src/app/metadata/package-constraints.ts

@@ -0,0 +1,20 @@
+import Joi from 'joi';
+
+/** @description Package size and weight constraints for a shipping service */
+export interface PackageConstraints {
+  /** @description Minimum package dimensions in LxWxH format (cm), e.g. "10x10x1" */
+  MinDimensions?: string | null;
+  /** @description Maximum package dimensions in LxWxH format (cm), e.g. "120x60x60" */
+  MaxDimensions?: string | null;
+  /** @description Minimum package weight in kg */
+  MinWeight?: number | null;
+  /** @description Maximum package weight in kg */
+  MaxWeight?: number | null;
+}
+
+export const PackageConstraintsSchema = Joi.object({
+  MinDimensions: Joi.string().optional().allow(null),
+  MaxDimensions: Joi.string().optional().allow(null),
+  MinWeight: Joi.number().optional().allow(null),
+  MaxWeight: Joi.number().optional().allow(null),
+});

package/src/app/metadata/shipping-provider-connector.ts

@@ -5,4 +5,6 @@ export interface ShippingProviderConnector {
   Functions: FunctionSpecification[];
   ApiVersion: string;
   DiagnosticRoutes?: DiagnosticRoutes;
+  /** @description Indicates whether the integration was developed by the carrier themselves (true) or by ShipStation (false) */
+  IsSelfIntegrated?: boolean;
 }

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

@@ -11,6 +11,11 @@ import {
 import Joi from 'joi';
 
 import { ApiCodeRegex, ApiCodeValidationMessage } from '@shipengine/connect-runtime';
+import { Transit, TransitSchema } from './transit';
+import { PackageConstraints, PackageConstraintsSchema } from './package-constraints';
+import { ServiceDirection } from './enums';
+
+const ServiceDirectionSchema = Joi.string().valid(...Object.values(ServiceDirection));
 
 /** @description Basic structure for each shipping service */
 export interface ShippingService {
@@ -42,6 +47,16 @@ export interface ShippingService {
   ApiCode?: string;
   /** @description The unique identifier for this shipping service. It should not change after being published */
   Id: string;
+  /** @description Customer-facing description of service capabilities and features */
+  ServiceDescription?: string;
+  /** @description Direction of this service */
+  ServiceDirection?: ServiceDirection;
+  /** @description List of ISO 3166-1 alpha-2 destination country codes supported by this service */
+  DestinationCountries?: string[];
+  /** @description Transit time and delivery schedule information */
+  Transit?: Transit;
+  /** @description Package size and weight constraints for this service */
+  PackageConstraints?: PackageConstraints;
 }
 
 export const ShippingServiceSchema = Joi.object({
@@ -59,4 +74,12 @@ export const ShippingServiceSchema = Joi.object({
   Name: Joi.string().required().max(80),
   ApiCode: Joi.string().optional().pattern(ApiCodeRegex, ApiCodeValidationMessage),
   Id: Joi.string().uuid().required(),
+  ServiceDescription: Joi.string().optional(),
+  ServiceDirection: ServiceDirectionSchema.optional(),
+  DestinationCountries: Joi.array()
+    .optional()
+    .items(Joi.string().pattern(/^[A-Z]{2}$/))
+    .unique(),
+  Transit: TransitSchema.optional(),
+  PackageConstraints: PackageConstraintsSchema.optional(),
 });

package/src/app/metadata/transit.ts

@@ -0,0 +1,36 @@
+import Joi from 'joi';
+import { DayOfWeek } from './enums';
+
+/** @description Operational schedule defining collection, trunking and delivery days */
+export interface OperationalSchedule {
+  /** @description Days on which the carrier collects parcels */
+  CollectionDays?: DayOfWeek[];
+  /** @description Days on which the carrier trunks parcels between hubs */
+  TrunkingDays?: DayOfWeek[];
+  /** @description Days on which the carrier delivers parcels */
+  DeliveryDays?: DayOfWeek[];
+}
+
+const DayOfWeekSchema = Joi.string().valid(...Object.values(DayOfWeek));
+
+export const OperationalScheduleSchema = Joi.object({
+  CollectionDays: Joi.array().optional().items(DayOfWeekSchema).unique(),
+  TrunkingDays: Joi.array().optional().items(DayOfWeekSchema).unique(),
+  DeliveryDays: Joi.array().optional().items(DayOfWeekSchema).unique(),
+});
+
+/** @description Transit information for a shipping service */
+export interface Transit {
+  /** @description Transit time in days, as a number or range (e.g. "3" or "3-5") */
+  TransitTimeInDays?: string | null;
+  /** @description Latest time of day by which delivery is made (e.g. "17:00") */
+  DeliveryByTime?: string | null;
+  /** @description Operational schedule for collection, trunking and delivery days */
+  OperationalSchedule?: OperationalSchedule;
+}
+
+export const TransitSchema = Joi.object({
+  TransitTimeInDays: Joi.string().optional().allow(null),
+  DeliveryByTime: Joi.string().optional().allow(null),
+  OperationalSchedule: OperationalScheduleSchema.optional(),
+});