@shipengine/connect-carrier-api 4.16.8-beta.4 → 4.16.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/app/metadata/carrier.d.ts +3 -0
- package/lib/app/metadata/carrier.js +4 -0
- package/lib/app/metadata/carrier.js.map +1 -1
- package/lib/app/metadata/enums.d.ts +7 -1
- package/lib/app/metadata/enums.js +8 -1
- package/lib/app/metadata/enums.js.map +1 -1
- package/lib/responses/create-manifest-response-schema.js +1 -1
- package/lib/responses/create-manifest-response-schema.js.map +1 -1
- package/lib/responses/create-manifest-response.d.ts +1 -3
- package/lib/responses/create-manifest-response.js.map +1 -1
- package/package.json +1 -1
- package/spec.json +6 -3
- package/src/app/metadata/carrier.ts +6 -0
- package/src/app/metadata/enums.ts +7 -0
- package/src/responses/create-manifest-response-schema.ts +1 -1
- package/src/responses/create-manifest-response.ts +1 -1
- package/tsconfig.tsbuildinfo +1 -1
|
@@ -13,6 +13,7 @@ import { Zone } from './zone';
|
|
|
13
13
|
import { PackageRatingGroup } from './package-rating-group';
|
|
14
14
|
import { AccountConnectionSpecification } from './account-connection-specification';
|
|
15
15
|
import { NormalizedErrors } from './normalized-errors';
|
|
16
|
+
import { TrackingSubscriptionLevel } from './enums';
|
|
16
17
|
/** @description Basic structure for each carrier */
|
|
17
18
|
export interface Carrier {
|
|
18
19
|
/** @description Defines UI Modals for connecting and updating settings */
|
|
@@ -64,5 +65,7 @@ export interface Carrier {
|
|
|
64
65
|
AccountConnection?: AccountConnectionSpecification;
|
|
65
66
|
/** @description This is the file path to the error library file, which connect-runtime uses to unify error returns from modules */
|
|
66
67
|
ErrorLibrary?: NormalizedErrors[];
|
|
68
|
+
/** @description Defines the subscription level required for a carrier to provide tracking updates. */
|
|
69
|
+
TrackingSubscriptionLevel?: TrackingSubscriptionLevel;
|
|
67
70
|
}
|
|
68
71
|
export declare const CarrierSchema: Joi.ObjectSchema<any>;
|
|
@@ -19,6 +19,7 @@ const connect_runtime_1 = require("@shipengine/connect-runtime");
|
|
|
19
19
|
const package_rating_group_1 = require("./package-rating-group");
|
|
20
20
|
const account_connection_specification_1 = require("./account-connection-specification");
|
|
21
21
|
const normalized_errors_1 = require("./normalized-errors");
|
|
22
|
+
const enums_1 = require("./enums");
|
|
22
23
|
exports.CarrierSchema = joi_1.default.object({
|
|
23
24
|
AccountModals: account_modals_1.AccountModalsSchema.required(),
|
|
24
25
|
PackageTypes: joi_1.default.array().optional().items(package_type_1.PackageTypeSchema).unique('Id'),
|
|
@@ -60,5 +61,8 @@ exports.CarrierSchema = joi_1.default.object({
|
|
|
60
61
|
PackageRatingGroups: joi_1.default.array().optional().items(package_rating_group_1.PackageRatingGroupSchema).unique('Id'),
|
|
61
62
|
AccountConnection: account_connection_specification_1.AccountConnectionSpecificationSchema.optional(),
|
|
62
63
|
ErrorLibrary: normalized_errors_1.NormalizedErrorsConfigurationSchema.optional(),
|
|
64
|
+
TrackingSubscriptionLevel: joi_1.default.string()
|
|
65
|
+
.valid(...Object.values(enums_1.TrackingSubscriptionLevel))
|
|
66
|
+
.optional(),
|
|
63
67
|
}).with('DocumentTemplate', 'ApiCode');
|
|
64
68
|
//# sourceMappingURL=carrier.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"carrier.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier.ts"],"names":[],"mappings":";;;;AAAA,qDAAsE;AACtE,iDAAgE;AAChE,yDAA4E;AAC5E,uDAA6F;AAC7F,+DAAqF;AACrF,6DAAwF;AACxF,mDAA2E;AAC3E,+CAAqE;AACrE,2DAA2F;AAC3F,sDAAsB;AACtB,+EAGuC;AACvC,iEAA6D;AAC7D,iCAA0C;AAE1C,iEAAqF;AACrF,iEAAsF;AACtF,yFAG4C;AAC5C,2DAA4F;
|
|
1
|
+
{"version":3,"file":"carrier.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier.ts"],"names":[],"mappings":";;;;AAAA,qDAAsE;AACtE,iDAAgE;AAChE,yDAA4E;AAC5E,uDAA6F;AAC7F,+DAAqF;AACrF,6DAAwF;AACxF,mDAA2E;AAC3E,+CAAqE;AACrE,2DAA2F;AAC3F,sDAAsB;AACtB,+EAGuC;AACvC,iEAA6D;AAC7D,iCAA0C;AAE1C,iEAAqF;AACrF,iEAAsF;AACtF,yFAG4C;AAC5C,2DAA4F;AAC5F,mCAAoD;AAyDvC,QAAA,aAAa,GAAG,aAAG,CAAC,MAAM,CAAC;IACtC,aAAa,EAAE,oCAAmB,CAAC,QAAQ,EAAE;IAC7C,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gCAAiB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1E,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,wCAAqB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAClF,eAAe,EAAE,gDAA8B,CAAC,QAAQ,EAAE;IAC1D,yBAAyB,EAAE,aAAG,CAAC,KAAK,EAAE;SACnC,QAAQ,EAAE;SACV,KAAK,CAAC,8CAAwB,CAAC;SAC/B,MAAM,CAAC,aAAa,CAAC;IACxB,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,kCAAoB,CAAC,CAAC,MAAM,EAAE;IAC9E,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,sCAAsB,CAAC,CAAC,MAAM,EAAE;IAC3E,wBAAwB,EAAE,gDAA4B,CAAC,QAAQ,EAAE;IACjE,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,+CAA0B,CAAC,CAAC,MAAM,EAAE;IACpF,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE;SACtB,QAAQ,EAAE;SACV,OAAO,CACN,IAAI,MAAM,CACR,iGAAiG,CAClG,CACF;SACA,OAAO,CAAC,qBAAqB,CAAC;SAC9B,GAAG,CAAC,GAAG,CAAC;IACX,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAClD,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,GAAG,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,MAAM,EAAE,aAAG,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;aACf,QAAQ,EAAE;aACV,MAAM,CAAC,wBAAU,EAAE,aAAa,CAAC;aACjC,OAAO,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;aACjC,OAAO,CAAC,iCAAiC,CAAC;QAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;aACf,QAAQ,EAAE;aACV,MAAM,CAAC,wBAAU,EAAE,aAAa,CAAC;aACjC,OAAO,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;aACjC,OAAO,CAAC,iCAAiC,CAAC;KAC9C,CAAC,CAAC,QAAQ,EAAE;IACb,YAAY,EAAE,6DAA+B,CAAC,QAAQ,EAAE;IACxD,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,wBAAU,EAAE,iBAAiB,CAAC;IAC/E,KAAK,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,iBAAU,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;IACjE,mBAAmB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,+CAAwB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IACxF,iBAAiB,EAAE,uEAAoC,CAAC,QAAQ,EAAE;IAClE,YAAY,EAAE,uDAAmC,CAAC,QAAQ,EAAE;IAC5D,yBAAyB,EAAE,aAAG,CAAC,MAAM,EAAE;SACpC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,iCAAyB,CAAC,CAAC;SAClD,QAAQ,EAAE;CACd,CAAC,CAAC,IAAI,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC"}
|
|
@@ -5,7 +5,8 @@ export declare enum CarrierAttribute {
|
|
|
5
5
|
Regional = "Regional",
|
|
6
6
|
RequiresInboundWebhook = "RequiresInboundWebhook",
|
|
7
7
|
DetailedStatuses = "DetailedStatuses",
|
|
8
|
-
ProofOfDelivery = "ProofOfDelivery"
|
|
8
|
+
ProofOfDelivery = "ProofOfDelivery",
|
|
9
|
+
TrackingSubscriptionLevel = "TrackingSubscriptionLevel"
|
|
9
10
|
}
|
|
10
11
|
export declare enum ShippingServiceAttribute {
|
|
11
12
|
Returns = "Returns",
|
|
@@ -49,3 +50,8 @@ export declare enum RequiredProperty {
|
|
|
49
50
|
Weight = "Weight",
|
|
50
51
|
Dimensions = "Dimensions"
|
|
51
52
|
}
|
|
53
|
+
export declare enum TrackingSubscriptionLevel {
|
|
54
|
+
None = "None",
|
|
55
|
+
TrackingNumber = "TrackingNumber",
|
|
56
|
+
Account = "Account"
|
|
57
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.RequiredProperty = exports.ServiceGrade = exports.ServiceClass = exports.SupportedLabelSize = exports.ShippingServiceAttribute = exports.CarrierAttribute = void 0;
|
|
3
|
+
exports.TrackingSubscriptionLevel = exports.RequiredProperty = exports.ServiceGrade = exports.ServiceClass = exports.SupportedLabelSize = exports.ShippingServiceAttribute = exports.CarrierAttribute = void 0;
|
|
4
4
|
var CarrierAttribute;
|
|
5
5
|
(function (CarrierAttribute) {
|
|
6
6
|
CarrierAttribute["ManifestDigital"] = "ManifestDigital";
|
|
@@ -10,6 +10,7 @@ var CarrierAttribute;
|
|
|
10
10
|
CarrierAttribute["RequiresInboundWebhook"] = "RequiresInboundWebhook";
|
|
11
11
|
CarrierAttribute["DetailedStatuses"] = "DetailedStatuses";
|
|
12
12
|
CarrierAttribute["ProofOfDelivery"] = "ProofOfDelivery";
|
|
13
|
+
CarrierAttribute["TrackingSubscriptionLevel"] = "TrackingSubscriptionLevel";
|
|
13
14
|
})(CarrierAttribute || (exports.CarrierAttribute = CarrierAttribute = {}));
|
|
14
15
|
var ShippingServiceAttribute;
|
|
15
16
|
(function (ShippingServiceAttribute) {
|
|
@@ -58,4 +59,10 @@ var RequiredProperty;
|
|
|
58
59
|
RequiredProperty["Weight"] = "Weight";
|
|
59
60
|
RequiredProperty["Dimensions"] = "Dimensions";
|
|
60
61
|
})(RequiredProperty || (exports.RequiredProperty = RequiredProperty = {}));
|
|
62
|
+
var TrackingSubscriptionLevel;
|
|
63
|
+
(function (TrackingSubscriptionLevel) {
|
|
64
|
+
TrackingSubscriptionLevel["None"] = "None";
|
|
65
|
+
TrackingSubscriptionLevel["TrackingNumber"] = "TrackingNumber";
|
|
66
|
+
TrackingSubscriptionLevel["Account"] = "Account";
|
|
67
|
+
})(TrackingSubscriptionLevel || (exports.TrackingSubscriptionLevel = TrackingSubscriptionLevel = {}));
|
|
61
68
|
//# sourceMappingURL=enums.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/app/metadata/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,
|
|
1
|
+
{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../../src/app/metadata/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,gBASX;AATD,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;AACzD,CAAC,EATW,gBAAgB,gCAAhB,gBAAgB,QAS3B;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"}
|
|
@@ -15,6 +15,6 @@ exports.CreateManifestResponseSchema = base_response_schema_1.BaseResponseSchema
|
|
|
15
15
|
manifest_status: manifest_status_schema_1.ManifestStatusSchema.optional,
|
|
16
16
|
total_shipments: joi_1.default.number().optional(),
|
|
17
17
|
total_invalid: joi_1.default.number().optional(),
|
|
18
|
-
manifest_identifiers: joi_1.default.
|
|
18
|
+
manifest_identifiers: joi_1.default.any().optional(),
|
|
19
19
|
});
|
|
20
20
|
//# sourceMappingURL=create-manifest-response-schema.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"create-manifest-response-schema.js","sourceRoot":"","sources":["../../src/responses/create-manifest-response-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,iEAA4D;AAC5D,6EAAwE;AACxE,qFAAgF;AAChF,yEAAqE;AAExD,QAAA,4BAA4B,GAAG,yCAAkB,CAAC,IAAI,CAAC;IAClE,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gCAAc,CAAC;IACvD,MAAM,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IACtC,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5C,eAAe,EAAE,6CAAoB,CAAC,QAAQ;IAC9C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,oBAAoB,EAAE,aAAG,CAAC,
|
|
1
|
+
{"version":3,"file":"create-manifest-response-schema.js","sourceRoot":"","sources":["../../src/responses/create-manifest-response-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,iEAA4D;AAC5D,6EAAwE;AACxE,qFAAgF;AAChF,yEAAqE;AAExD,QAAA,4BAA4B,GAAG,yCAAkB,CAAC,IAAI,CAAC;IAClE,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gCAAc,CAAC;IACvD,MAAM,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IACtC,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5C,eAAe,EAAE,6CAAoB,CAAC,QAAQ;IAC9C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,oBAAoB,EAAE,aAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"create-manifest-response.js","sourceRoot":"","sources":["../../src/responses/create-manifest-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAI/C,uEAAuE;AACvE,MAAa,sBAAuB,SAAQ,4BAAY;IACtD,cAAc,CAAU;IACxB,SAAS,CAAc;IACvB,MAAM,CAAmB;IACzB,mBAAmB,CAAU;IAC7B,eAAe,CAAkB;IACjC,eAAe,CAAU;IACzB,aAAa,CAAU;IACvB,oBAAoB,
|
|
1
|
+
{"version":3,"file":"create-manifest-response.js","sourceRoot":"","sources":["../../src/responses/create-manifest-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAI/C,uEAAuE;AACvE,MAAa,sBAAuB,SAAQ,4BAAY;IACtD,cAAc,CAAU;IACxB,SAAS,CAAc;IACvB,MAAM,CAAmB;IACzB,mBAAmB,CAAU;IAC7B,eAAe,CAAkB;IACjC,eAAe,CAAU;IACzB,aAAa,CAAU;IACvB,oBAAoB,CAAO;CAC5B;AATD,wDASC"}
|
package/package.json
CHANGED
package/spec.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Shipping API",
|
|
5
5
|
"description": "This API specification describes the canonical ShipEngine Shipping API connector module.",
|
|
6
|
-
"version": "1.28.
|
|
6
|
+
"version": "1.28.4"
|
|
7
7
|
},
|
|
8
8
|
"paths": {
|
|
9
9
|
"/Register": {
|
|
@@ -1165,7 +1165,7 @@
|
|
|
1165
1165
|
"properties": {
|
|
1166
1166
|
"metadata": {
|
|
1167
1167
|
"type": "object",
|
|
1168
|
-
"additionalProperties":
|
|
1168
|
+
"additionalProperties": true,
|
|
1169
1169
|
"description": "This is an optional schemaless object that you may return with a successful response. Anything returned\r\nunder this key will be included in all future requests. For example, you may store additional static\r\nproperties about the end user or their connection to the carrier. The maximum storage size\r\nfor data under this key is 4KB.",
|
|
1170
1170
|
"nullable": true
|
|
1171
1171
|
}
|
|
@@ -1816,7 +1816,10 @@
|
|
|
1816
1816
|
},
|
|
1817
1817
|
"manifest_identifiers": {
|
|
1818
1818
|
"type": "object",
|
|
1819
|
-
"additionalProperties": {
|
|
1819
|
+
"additionalProperties": {
|
|
1820
|
+
"type": "object",
|
|
1821
|
+
"nullable": true
|
|
1822
|
+
},
|
|
1820
1823
|
"description": "Carrier information needed to get created manifests.\r\nOnly needed if carrier requires two calls to create and get manifests.",
|
|
1821
1824
|
"nullable": true
|
|
1822
1825
|
}
|
|
@@ -22,6 +22,7 @@ import {
|
|
|
22
22
|
AccountConnectionSpecificationSchema,
|
|
23
23
|
} from './account-connection-specification';
|
|
24
24
|
import { NormalizedErrors, NormalizedErrorsConfigurationSchema } from './normalized-errors';
|
|
25
|
+
import { TrackingSubscriptionLevel } from './enums';
|
|
25
26
|
|
|
26
27
|
/** @description Basic structure for each carrier */
|
|
27
28
|
export interface Carrier {
|
|
@@ -74,6 +75,8 @@ export interface Carrier {
|
|
|
74
75
|
AccountConnection?: AccountConnectionSpecification;
|
|
75
76
|
/** @description This is the file path to the error library file, which connect-runtime uses to unify error returns from modules */
|
|
76
77
|
ErrorLibrary?: NormalizedErrors[];
|
|
78
|
+
/** @description Defines the subscription level required for a carrier to provide tracking updates. */
|
|
79
|
+
TrackingSubscriptionLevel?: TrackingSubscriptionLevel;
|
|
77
80
|
}
|
|
78
81
|
|
|
79
82
|
export const CarrierSchema = Joi.object({
|
|
@@ -121,4 +124,7 @@ export const CarrierSchema = Joi.object({
|
|
|
121
124
|
PackageRatingGroups: Joi.array().optional().items(PackageRatingGroupSchema).unique('Id'),
|
|
122
125
|
AccountConnection: AccountConnectionSpecificationSchema.optional(),
|
|
123
126
|
ErrorLibrary: NormalizedErrorsConfigurationSchema.optional(),
|
|
127
|
+
TrackingSubscriptionLevel: Joi.string()
|
|
128
|
+
.valid(...Object.values(TrackingSubscriptionLevel))
|
|
129
|
+
.optional(),
|
|
124
130
|
}).with('DocumentTemplate', 'ApiCode');
|
|
@@ -6,6 +6,7 @@ export enum CarrierAttribute {
|
|
|
6
6
|
RequiresInboundWebhook = 'RequiresInboundWebhook',
|
|
7
7
|
DetailedStatuses = 'DetailedStatuses',
|
|
8
8
|
ProofOfDelivery = 'ProofOfDelivery',
|
|
9
|
+
TrackingSubscriptionLevel = 'TrackingSubscriptionLevel',
|
|
9
10
|
}
|
|
10
11
|
|
|
11
12
|
export enum ShippingServiceAttribute {
|
|
@@ -54,3 +55,9 @@ export enum RequiredProperty {
|
|
|
54
55
|
Weight = 'Weight',
|
|
55
56
|
Dimensions = 'Dimensions',
|
|
56
57
|
}
|
|
58
|
+
|
|
59
|
+
export enum TrackingSubscriptionLevel {
|
|
60
|
+
None = 'None',
|
|
61
|
+
TrackingNumber = 'TrackingNumber',
|
|
62
|
+
Account = 'Account',
|
|
63
|
+
}
|
|
@@ -12,5 +12,5 @@ export const CreateManifestResponseSchema = BaseResponseSchema.keys({
|
|
|
12
12
|
manifest_status: ManifestStatusSchema.optional,
|
|
13
13
|
total_shipments: Joi.number().optional(),
|
|
14
14
|
total_invalid: Joi.number().optional(),
|
|
15
|
-
manifest_identifiers: Joi.
|
|
15
|
+
manifest_identifiers: Joi.any().optional(),
|
|
16
16
|
});
|