@shipengine/connect-carrier-api 4.16.11 → 4.17.4

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

@@ -1,7 +1,7 @@
 import { ImportedTrackingEvent } from '../models';
 import type { Request } from 'express';
-import { RegisterRequest, CreateLabelRequest, VoidLabelsRequest, CreateManifestRequest, GetManifestRequest, SchedulePickupRequest, CancelPickupRequest, GetRatesRequest, TrackingRequest, CancelNotificationRequest, CreateNotificationRequest, ValidateInboundDataRequest, NormalizeTrackingDataRequest, GetRelayPointsRequest, GetServicePointsRequest, GetServicePointRequest, ImportTrackingEventsRequest, UpdateSettingsRequest, ListPickupsRequest } from '../requests';
-import { RegisterResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse, ValidateInboundDataResponse, NormalizeTrackingDataResponse, GetRelayPointsResponse, GetServicePointsResponse, GetServicePointResponse, UpdateSettingsResponse, ListPickupsResponse } from '../responses';
+import { RegisterRequest, CreateLabelRequest, VoidLabelsRequest, CreateManifestRequest, GetManifestRequest, SchedulePickupRequest, CancelPickupRequest, GetRatesRequest, TrackingRequest, CancelNotificationRequest, CreateNotificationRequest, ValidateInboundDataRequest, NormalizeTrackingDataRequest, GetRelayPointsRequest, GetServicePointsRequest, GetServicePointRequest, ImportTrackingEventsRequest, UpdateSettingsRequest, ListPickupsRequest, StartTrackingRequest } from '../requests';
+import { RegisterResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse, ValidateInboundDataResponse, NormalizeTrackingDataResponse, GetRelayPointsResponse, GetServicePointsResponse, GetServicePointResponse, UpdateSettingsResponse, ListPickupsResponse, StartTrackingResponse } from '../responses';
 import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
 import { RequestResponseInfo, Handler } from '@shipengine/connect-runtime';
 /**
@@ -111,6 +111,11 @@ export interface CarrierAppDefinition {
      * @param request Data needed by the provider to update carrier settings
      */
     UpdateSettings?: (request: UpdateSettingsRequest) => UpdateSettingsResponse | Promise<UpdateSettingsResponse>;
+    /**
+     * @description This endpoint is used to subscribe for status updates from the carrier
+     * @param request Data needed by the provider to start tracking shipments
+     */
+    StartTracking?: (request: StartTrackingRequest) => StartTrackingResponse | Promise<StartTrackingResponse>;
     /**
      * @description A collection of additional routes that can be used to extend the functionality of the app.
      * Extension methods are not automatically called by the ShipEngine platform, and require working with Auctane developers to implement.

package/lib/app/constants.d.ts

@@ -17,5 +17,6 @@ export declare enum ApiEndpoints {
     GetServicePoint = "/GetServicePoint",
     ImportTrackingEvents = "/ImportTrackingEvents",
     UpdateSettings = "/UpdateSettings",
-    ListPickups = "/ListPickups"
+    ListPickups = "/ListPickups",
+    StartTracking = "/StartTracking"
 }

package/lib/app/constants.js

@@ -22,5 +22,6 @@ var ApiEndpoints;
     ApiEndpoints["ImportTrackingEvents"] = "/ImportTrackingEvents";
     ApiEndpoints["UpdateSettings"] = "/UpdateSettings";
     ApiEndpoints["ListPickups"] = "/ListPickups";
+    ApiEndpoints["StartTracking"] = "/StartTracking";
 })(ApiEndpoints || (exports.ApiEndpoints = ApiEndpoints = {}));
 //# sourceMappingURL=constants.js.map

package/lib/app/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/app/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAoBX;AApBD,WAAY,YAAY;IACtB,sCAAsB,CAAA;IACtB,4CAA4B,CAAA;IAC5B,0CAA0B,CAAA;IAC1B,sCAAsB,CAAA;IACtB,kDAAkC,CAAA;IAClC,4CAA4B,CAAA;IAC5B,kDAAkC,CAAA;IAClC,8CAA8B,CAAA;IAC9B,gCAAgB,CAAA;IAChB,0DAA0C,CAAA;IAC1C,0DAA0C,CAAA;IAC1C,4DAA4C,CAAA;IAC5C,gEAAgD,CAAA;IAChD,kDAAkC,CAAA;IAClC,sDAAsC,CAAA;IACtC,oDAAoC,CAAA;IACpC,8DAA8C,CAAA;IAC9C,kDAAkC,CAAA;IAClC,4CAA4B,CAAA;AAC9B,CAAC,EApBW,YAAY,4BAAZ,YAAY,QAoBvB"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/app/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAqBX;AArBD,WAAY,YAAY;IACtB,sCAAsB,CAAA;IACtB,4CAA4B,CAAA;IAC5B,0CAA0B,CAAA;IAC1B,sCAAsB,CAAA;IACtB,kDAAkC,CAAA;IAClC,4CAA4B,CAAA;IAC5B,kDAAkC,CAAA;IAClC,8CAA8B,CAAA;IAC9B,gCAAgB,CAAA;IAChB,0DAA0C,CAAA;IAC1C,0DAA0C,CAAA;IAC1C,4DAA4C,CAAA;IAC5C,gEAAgD,CAAA;IAChD,kDAAkC,CAAA;IAClC,sDAAsC,CAAA;IACtC,oDAAoC,CAAA;IACpC,8DAA8C,CAAA;IAC9C,kDAAkC,CAAA;IAClC,4CAA4B,CAAA;IAC5B,gDAAgC,CAAA;AAClC,CAAC,EArBW,YAAY,4BAAZ,YAAY,QAqBvB"}

package/lib/app/create-endpoint-mapping.js

@@ -25,6 +25,7 @@ const createEndpointMapping = (definition) => [
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.ImportTrackingEvents, definition.ImportTrackingEvents],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.UpdateSettings, definition.UpdateSettings],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.ListPickups, definition.ListPickups],
+    [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.StartTracking, definition.StartTracking],
     ...(0, connect_runtime_1.mapExtensions)(definition.Extensions),
 ];
 exports.createEndpointMapping = createEndpointMapping;

package/lib/app/create-endpoint-mapping.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-endpoint-mapping.js","sourceRoot":"","sources":["../../src/app/create-endpoint-mapping.ts"],"names":[],"mappings":";;;AAAA,iEAA6E;AAC7E,2CAA2C;AAGpC,MAAM,qBAAqB,GAAG,CACnC,UAAgC,EACS,EAAE,CAAC;IAC5C,iFAAiF;IACjF,yFAAyF;IACzF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,YAAY,EAAE,UAAU,CAAC,YAAY,CAAC;IACjE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,CAAC;IACnF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;IACnD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,mBAAmB,EAAE,UAAU,CAAC,mBAAmB,CAAC;IAC/E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;IAC7D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,gBAAgB,EAAE,UAAU,CAAC,gBAAgB,CAAC;IACzE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,eAAe,EAAE,UAAU,CAAC,eAAe,CAAC;IACvE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,oBAAoB,EAAE,UAAU,CAAC,oBAAoB,CAAC;IACjF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,GAAG,IAAA,+BAAa,EAAC,UAAU,CAAC,UAAU,CAAC;CACxC,CAAC;AAzBW,QAAA,qBAAqB,yBAyBhC"}
+{"version":3,"file":"create-endpoint-mapping.js","sourceRoot":"","sources":["../../src/app/create-endpoint-mapping.ts"],"names":[],"mappings":";;;AAAA,iEAA6E;AAC7E,2CAA2C;AAGpC,MAAM,qBAAqB,GAAG,CACnC,UAAgC,EACS,EAAE,CAAC;IAC5C,iFAAiF;IACjF,yFAAyF;IACzF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,YAAY,EAAE,UAAU,CAAC,YAAY,CAAC;IACjE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,CAAC;IACnF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;IACnD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,mBAAmB,EAAE,UAAU,CAAC,mBAAmB,CAAC;IAC/E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;IAC7D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,gBAAgB,EAAE,UAAU,CAAC,gBAAgB,CAAC;IACzE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,eAAe,EAAE,UAAU,CAAC,eAAe,CAAC;IACvE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,oBAAoB,EAAE,UAAU,CAAC,oBAAoB,CAAC;IACjF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,aAAa,EAAE,UAAU,CAAC,aAAa,CAAC;IACnE,GAAG,IAAA,+BAAa,EAAC,UAAU,CAAC,UAAU,CAAC;CACxC,CAAC;AA1BW,QAAA,qBAAqB,yBA0BhC"}

package/lib/models/tracking/index.d.ts

@@ -16,3 +16,5 @@ export * from './update-method-schema';
 export * from './update-method';
 export * from './standardized-status-detail-codes';
 export * from './standardized-status-detail-codes-schema';
+export * from './start-tracking-status';
+export * from './start-tracking-status-schema';

package/lib/models/tracking/index.js

@@ -19,4 +19,6 @@ tslib_1.__exportStar(require("./update-method-schema"), exports);
 tslib_1.__exportStar(require("./update-method"), exports);
 tslib_1.__exportStar(require("./standardized-status-detail-codes"), exports);
 tslib_1.__exportStar(require("./standardized-status-detail-codes-schema"), exports);
+tslib_1.__exportStar(require("./start-tracking-status"), exports);
+tslib_1.__exportStar(require("./start-tracking-status-schema"), exports);
 //# sourceMappingURL=index.js.map

package/lib/models/tracking/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/tracking/index.ts"],"names":[],"mappings":";;;AAAA,2EAAiD;AACjD,oEAA0C;AAC1C,4DAAkC;AAClC,qDAA2B;AAC3B,2DAAiC;AACjC,oDAA0B;AAC1B,6EAAmD;AACnD,sEAA4C;AAC5C,+DAAqC;AACrC,wDAA8B;AAC9B,+DAAqC;AACrC,gEAAsC;AACtC,iEAAuC;AACvC,0DAAgC;AAChC,iEAAuC;AACvC,0DAAgC;AAChC,6EAAmD;AACnD,oFAA0D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/tracking/index.ts"],"names":[],"mappings":";;;AAAA,2EAAiD;AACjD,oEAA0C;AAC1C,4DAAkC;AAClC,qDAA2B;AAC3B,2DAAiC;AACjC,oDAA0B;AAC1B,6EAAmD;AACnD,sEAA4C;AAC5C,+DAAqC;AACrC,wDAA8B;AAC9B,+DAAqC;AACrC,gEAAsC;AACtC,iEAAuC;AACvC,0DAAgC;AAChC,iEAAuC;AACvC,0DAAgC;AAChC,6EAAmD;AACnD,oFAA0D;AAC1D,kEAAwC;AACxC,yEAA+C"}

package/lib/models/tracking/start-tracking-status-schema.d.ts

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

package/lib/models/tracking/start-tracking-status-schema.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionStatusSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const start_tracking_status_1 = require("./start-tracking-status");
+exports.SubscriptionStatusSchema = joi_1.default.string()
+    .valid(...Object.values(start_tracking_status_1.StartTrackingStatus))
+    .required();
+//# sourceMappingURL=start-tracking-status-schema.js.map

package/lib/models/tracking/start-tracking-status-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-tracking-status-schema.js","sourceRoot":"","sources":["../../../src/models/tracking/start-tracking-status-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,mEAA8D;AAEjD,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,EAAE;KACjD,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,2CAAmB,CAAC,CAAC;KAC5C,QAAQ,EAAE,CAAC"}

package/lib/models/tracking/start-tracking-status.d.ts

@@ -0,0 +1,7 @@
+/** Status of subscription results */
+export declare enum StartTrackingStatus {
+    /** @description The tracking subscription was created successfully */
+    SUCCESS = "SUCCESS",
+    /** @description The tracking subscription could not be created */
+    FAILED = "FAILED"
+}

package/lib/models/tracking/start-tracking-status.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartTrackingStatus = void 0;
+/** Status of subscription results */
+var StartTrackingStatus;
+(function (StartTrackingStatus) {
+    /** @description The tracking subscription was created successfully */
+    StartTrackingStatus["SUCCESS"] = "SUCCESS";
+    /** @description The tracking subscription could not be created */
+    StartTrackingStatus["FAILED"] = "FAILED";
+})(StartTrackingStatus || (exports.StartTrackingStatus = StartTrackingStatus = {}));
+//# sourceMappingURL=start-tracking-status.js.map

package/lib/models/tracking/start-tracking-status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-tracking-status.js","sourceRoot":"","sources":["../../../src/models/tracking/start-tracking-status.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AACrC,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,sEAAsE;IACtE,0CAAmB,CAAA;IACnB,kEAAkE;IAClE,wCAAiB,CAAA;AACnB,CAAC,EALW,mBAAmB,mCAAnB,mBAAmB,QAK9B"}

package/lib/requests/index.d.ts

@@ -17,3 +17,5 @@ export * from './tracking-request';
 export * from './validate-inbound-data-request';
 export * from './void-labels-request';
 export * from './update-settings-request';
+export * from './start-tracking-request';
+export * from './start-tracking-request-schema';

package/lib/requests/index.js

@@ -20,4 +20,6 @@ tslib_1.__exportStar(require("./tracking-request"), exports);
 tslib_1.__exportStar(require("./validate-inbound-data-request"), exports);
 tslib_1.__exportStar(require("./void-labels-request"), exports);
 tslib_1.__exportStar(require("./update-settings-request"), exports);
+tslib_1.__exportStar(require("./start-tracking-request"), exports);
+tslib_1.__exportStar(require("./start-tracking-request-schema"), exports);
 //# sourceMappingURL=index.js.map

package/lib/requests/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/requests/index.ts"],"names":[],"mappings":";;;AAAA,wEAA8C;AAC9C,kEAAwC;AACxC,iEAAuC;AACvC,oEAA0C;AAC1C,wEAA8C;AAC9C,iEAAuC;AACvC,8DAAoC;AACpC,qEAA2C;AAC3C,sEAA4C;AAC5C,uEAA6C;AAC7C,2EAAiD;AACjD,4EAAkD;AAClD,6DAAmC;AACnC,oEAA0C;AAC1C,iEAAuC;AACvC,6DAAmC;AACnC,0EAAgD;AAChD,gEAAsC;AACtC,oEAA0C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/requests/index.ts"],"names":[],"mappings":";;;AAAA,wEAA8C;AAC9C,kEAAwC;AACxC,iEAAuC;AACvC,oEAA0C;AAC1C,wEAA8C;AAC9C,iEAAuC;AACvC,8DAAoC;AACpC,qEAA2C;AAC3C,sEAA4C;AAC5C,uEAA6C;AAC7C,2EAAiD;AACjD,4EAAkD;AAClD,6DAAmC;AACnC,oEAA0C;AAC1C,iEAAuC;AACvC,6DAAmC;AACnC,0EAAgD;AAChD,gEAAsC;AACtC,oEAA0C;AAC1C,mEAAyC;AACzC,0EAAgD"}

package/lib/requests/start-tracking-request-schema.d.ts

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

package/lib/requests/start-tracking-request-schema.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartTrackingRequestSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const identifier_schema_1 = require("../models/identifier-schema");
+const base_request_schema_1 = require("./base-request-schema");
+exports.StartTrackingRequestSchema = base_request_schema_1.BaseRequestSchema.keys({
+    identifiers: joi_1.default.array().required().items(identifier_schema_1.IdentifierSchema),
+});
+//# sourceMappingURL=start-tracking-request-schema.js.map

package/lib/requests/start-tracking-request-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-tracking-request-schema.js","sourceRoot":"","sources":["../../src/requests/start-tracking-request-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,mEAA+D;AAC/D,+DAA0D;AAE7C,QAAA,0BAA0B,GAAG,uCAAiB,CAAC,IAAI,CAAC;IAC/D,WAAW,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,oCAAgB,CAAC;CAC5D,CAAC,CAAC"}

package/lib/requests/start-tracking-request.d.ts

@@ -0,0 +1,8 @@
+import { BaseRequest } from './base-request';
+import { Identifier } from '../models/identifier';
+/**
+ * @description Request to start tracking shipments using identifiers
+ */
+export declare class StartTrackingRequest extends BaseRequest {
+    identifiers: Identifier[];
+}

package/lib/requests/start-tracking-request.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartTrackingRequest = void 0;
+const base_request_1 = require("./base-request");
+/**
+ * @description Request to start tracking shipments using identifiers
+ */
+class StartTrackingRequest extends base_request_1.BaseRequest {
+    identifiers;
+}
+exports.StartTrackingRequest = StartTrackingRequest;
+//# sourceMappingURL=start-tracking-request.js.map

package/lib/requests/start-tracking-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-tracking-request.js","sourceRoot":"","sources":["../../src/requests/start-tracking-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAG7C;;GAEG;AACH,MAAa,oBAAqB,SAAQ,0BAAW;IACnD,WAAW,CAAgB;CAC5B;AAFD,oDAEC"}

package/lib/responses/index.d.ts

@@ -33,3 +33,5 @@ export * from './void-labels-response-schema';
 export * from './void-labels-response';
 export * from './update-settings-response-schema';
 export * from './update-settings-response';
+export * from './start-tracking-response';
+export * from './start-tracking-response-schema';

package/lib/responses/index.js

@@ -36,4 +36,6 @@ tslib_1.__exportStar(require("./void-labels-response-schema"), exports);
 tslib_1.__exportStar(require("./void-labels-response"), exports);
 tslib_1.__exportStar(require("./update-settings-response-schema"), exports);
 tslib_1.__exportStar(require("./update-settings-response"), exports);
+tslib_1.__exportStar(require("./start-tracking-response"), exports);
+tslib_1.__exportStar(require("./start-tracking-response-schema"), exports);
 //# sourceMappingURL=index.js.map

package/lib/responses/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":";;;AAAA,gFAAsD;AACtD,yEAA+C;AAC/C,0EAAgD;AAChD,mEAAyC;AACzC,yEAA+C;AAC/C,kEAAwC;AACxC,4EAAkD;AAClD,qEAA2C;AAC3C,gFAAsD;AACtD,yEAA+C;AAC/C,2DAAiC;AACjC,sEAA4C;AAC5C,+DAAqC;AACrC,6EAAmD;AACnD,sEAA4C;AAC5C,8EAAoD;AACpD,uEAA6C;AAC7C,+EAAqD;AACrD,wEAA8C;AAC9C,oFAA0D;AAC1D,6EAAmD;AACnD,qEAA2C;AAC3C,8DAAoC;AACpC,4EAAkD;AAClD,qEAA2C;AAC3C,yEAA+C;AAC/C,kEAAwC;AACxC,qEAA2C;AAC3C,8DAAoC;AACpC,kFAAwD;AACxD,2EAAiD;AACjD,wEAA8C;AAC9C,iEAAuC;AACvC,4EAAkD;AAClD,qEAA2C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":";;;AAAA,gFAAsD;AACtD,yEAA+C;AAC/C,0EAAgD;AAChD,mEAAyC;AACzC,yEAA+C;AAC/C,kEAAwC;AACxC,4EAAkD;AAClD,qEAA2C;AAC3C,gFAAsD;AACtD,yEAA+C;AAC/C,2DAAiC;AACjC,sEAA4C;AAC5C,+DAAqC;AACrC,6EAAmD;AACnD,sEAA4C;AAC5C,8EAAoD;AACpD,uEAA6C;AAC7C,+EAAqD;AACrD,wEAA8C;AAC9C,oFAA0D;AAC1D,6EAAmD;AACnD,qEAA2C;AAC3C,8DAAoC;AACpC,4EAAkD;AAClD,qEAA2C;AAC3C,yEAA+C;AAC/C,kEAAwC;AACxC,qEAA2C;AAC3C,8DAAoC;AACpC,kFAAwD;AACxD,2EAAiD;AACjD,wEAA8C;AAC9C,iEAAuC;AACvC,4EAAkD;AAClD,qEAA2C;AAC3C,oEAA0C;AAC1C,2EAAiD"}

package/lib/responses/start-tracking-response-schema.d.ts

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

package/lib/responses/start-tracking-response-schema.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartTrackingResponseSchema = exports.SubscriptionResultSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const identifier_schema_1 = require("../models/identifier-schema");
+const base_response_schema_1 = require("./base-response-schema");
+const start_tracking_status_schema_1 = require("../models/tracking/start-tracking-status-schema");
+exports.SubscriptionResultSchema = joi_1.default.object({
+    identifier: identifier_schema_1.IdentifierSchema.required(),
+    status: start_tracking_status_schema_1.SubscriptionStatusSchema,
+    message: joi_1.default.string().required(),
+});
+exports.StartTrackingResponseSchema = base_response_schema_1.BaseResponseSchema.keys({
+    subscription_results: joi_1.default.array().required().items(exports.SubscriptionResultSchema),
+});
+//# sourceMappingURL=start-tracking-response-schema.js.map

package/lib/responses/start-tracking-response-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-tracking-response-schema.js","sourceRoot":"","sources":["../../src/responses/start-tracking-response-schema.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,mEAA+D;AAC/D,iEAA4D;AAC5D,kGAA2F;AAE9E,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,UAAU,EAAE,oCAAgB,CAAC,QAAQ,EAAE;IACvC,MAAM,EAAE,uDAAwB;IAChC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAEU,QAAA,2BAA2B,GAAG,yCAAkB,CAAC,IAAI,CAAC;IACjE,oBAAoB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gCAAwB,CAAC;CAC7E,CAAC,CAAC"}

package/lib/responses/start-tracking-response.d.ts

@@ -0,0 +1,14 @@
+import { BaseResponse } from './base-response';
+import { Identifier } from '../models';
+import { StartTrackingStatus } from '../models/tracking/start-tracking-status';
+/**
+ * @description Response from start tracking subscriptions
+ */
+export declare class StartTrackingResponse extends BaseResponse {
+    subscription_results: SubscriptionResult[];
+}
+export interface SubscriptionResult {
+    identifier: Identifier;
+    status: StartTrackingStatus;
+    message: string;
+}

package/lib/responses/start-tracking-response.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartTrackingResponse = void 0;
+const base_response_1 = require("./base-response");
+/**
+ * @description Response from start tracking subscriptions
+ */
+class StartTrackingResponse extends base_response_1.BaseResponse {
+    subscription_results;
+}
+exports.StartTrackingResponse = StartTrackingResponse;
+//# sourceMappingURL=start-tracking-response.js.map

package/lib/responses/start-tracking-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-tracking-response.js","sourceRoot":"","sources":["../../src/responses/start-tracking-response.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAI/C;;GAEG;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,oBAAoB,CAAwB;CAC7C;AAFD,sDAEC"}

package/package.json

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

package/spec.json

@@ -947,6 +947,45 @@
         }
       }
     },
+    "/StartTracking": {
+      "post": {
+        "tags": ["Tracking"],
+        "description": "This method subscribes to tracking events for one or more identifiers. This endpoint initiate the subscription with the carrier's system.",
+        "operationId": "StartTracking",
+        "requestBody": {
+          "description": "An object containing identifiers to subscribe to tracking events for.",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/StartTrackingRequest"
+              },
+              "example": {
+                "identifiers": [
+                  { "type": "tracking_number", "value": "PL1234567890" },
+                  { "type": "tracking_number", "value": "PL0987654321" }
+                ],
+                "transaction_id": "771323cb-75eb-4e2a-bc11-fda608c6ade8",
+                "authorization": {},
+                "metadata": {},
+                "connection_name": "a_connect_connection_name_string"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Successful subscription response with results for each identifier.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/StartTrackingResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/UpdateSettings": {
       "post": {
         "tags": [
@@ -5352,6 +5391,72 @@
         "additionalProperties": false,
         "description": "This model represents the successful response from a tracking request."
       },
+      "StartTrackingRequest": {
+        "required": ["identifiers", "transaction_id"],
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseRequest"
+          }
+        ],
+        "properties": {
+          "identifiers": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TrackingIdentifier"
+            },
+            "description": "Array of identifiers (e.g., tracking numbers) to subscribe to tracking events for.",
+            "nullable": false
+          }
+        },
+        "additionalProperties": false,
+        "description": "This model represents the request payload for subscribing to tracking events for one or more identifiers."
+      },
+      "StartTrackingResponse": {
+        "required": ["subscription_results"],
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseResponse"
+          }
+        ],
+        "properties": {
+          "subscription_results": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SubscriptionResult"
+            },
+            "description": "Array of subscription results, one for each identifier in the request.",
+            "nullable": false
+          }
+        },
+        "additionalProperties": false,
+        "description": "This model represents the response from a start tracking subscription request."
+      },
+      "SubscriptionResult": {
+        "required": ["identifier", "status"],
+        "type": "object",
+        "properties": {
+          "identifier": {
+            "$ref": "#/components/schemas/TrackingIdentifier"
+          },
+          "status": {
+            "$ref": "#/components/schemas/SubscriptionStatus"
+          },
+          "message": {
+            "type": "string",
+            "description": "Optional message providing additional details about the subscription result.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "This model represents the result of a tracking subscription attempt for a single identifier."
+      },
+      "SubscriptionStatus": {
+        "enum": ["success", "failed"],
+        "type": "string",
+        "description": "Status of the tracking subscription attempt.\nsuccess - Subscription was successful\nfailed - Subscription failed"
+      },
       "TransportMeanEnum": {
         "enum": [
           "ground",

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

@@ -20,6 +20,7 @@ import {
   ImportTrackingEventsRequest,
   UpdateSettingsRequest,
   ListPickupsRequest,
+  StartTrackingRequest,
 } from '../requests';
 
 import {
@@ -40,6 +41,7 @@ import {
   GetServicePointResponse,
   UpdateSettingsResponse,
   ListPickupsResponse,
+  StartTrackingResponse,
 } from '../responses';
 
 import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
@@ -183,6 +185,13 @@ export interface CarrierAppDefinition {
   UpdateSettings?: (
     request: UpdateSettingsRequest,
   ) => UpdateSettingsResponse | Promise<UpdateSettingsResponse>;
+  /**
+   * @description This endpoint is used to subscribe for status updates from the carrier
+   * @param request Data needed by the provider to start tracking shipments
+   */
+  StartTracking?: (
+    request: StartTrackingRequest,
+  ) => StartTrackingResponse | Promise<StartTrackingResponse>;
   /**
    * @description A collection of additional routes that can be used to extend the functionality of the app.
    * Extension methods are not automatically called by the ShipEngine platform, and require working with Auctane developers to implement.

package/src/app/constants.ts

@@ -18,4 +18,5 @@ export enum ApiEndpoints {
   ImportTrackingEvents = '/ImportTrackingEvents',
   UpdateSettings = '/UpdateSettings',
   ListPickups = '/ListPickups',
+  StartTracking = '/StartTracking',
 }

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

@@ -26,5 +26,6 @@ export const createEndpointMapping = (
   [Method.POST, ApiEndpoints.ImportTrackingEvents, definition.ImportTrackingEvents],
   [Method.POST, ApiEndpoints.UpdateSettings, definition.UpdateSettings],
   [Method.POST, ApiEndpoints.ListPickups, definition.ListPickups],
+  [Method.POST, ApiEndpoints.StartTracking, definition.StartTracking],
   ...mapExtensions(definition.Extensions),
 ];

package/src/models/tracking/index.ts

@@ -16,3 +16,5 @@ export * from './update-method-schema';
 export * from './update-method';
 export * from './standardized-status-detail-codes';
 export * from './standardized-status-detail-codes-schema';
+export * from './start-tracking-status';
+export * from './start-tracking-status-schema';

package/src/models/tracking/start-tracking-status-schema.ts

@@ -0,0 +1,6 @@
+import Joi from 'joi';
+import { StartTrackingStatus } from './start-tracking-status';
+
+export const SubscriptionStatusSchema = Joi.string()
+  .valid(...Object.values(StartTrackingStatus))
+  .required();

package/src/models/tracking/start-tracking-status.ts

@@ -0,0 +1,7 @@
+/** Status of subscription results */
+export enum StartTrackingStatus {
+  /** @description The tracking subscription was created successfully */
+  SUCCESS = 'SUCCESS',
+  /** @description The tracking subscription could not be created */
+  FAILED = 'FAILED',
+}

package/src/requests/index.ts

@@ -17,3 +17,5 @@ export * from './tracking-request';
 export * from './validate-inbound-data-request';
 export * from './void-labels-request';
 export * from './update-settings-request';
+export * from './start-tracking-request';
+export * from './start-tracking-request-schema';

package/src/requests/start-tracking-request-schema.ts

@@ -0,0 +1,7 @@
+import Joi from 'joi';
+import { IdentifierSchema } from '../models/identifier-schema';
+import { BaseRequestSchema } from './base-request-schema';
+
+export const StartTrackingRequestSchema = BaseRequestSchema.keys({
+  identifiers: Joi.array().required().items(IdentifierSchema),
+});

package/src/requests/start-tracking-request.ts

@@ -0,0 +1,9 @@
+import { BaseRequest } from './base-request';
+import { Identifier } from '../models/identifier';
+
+/**
+ * @description Request to start tracking shipments using identifiers
+ */
+export class StartTrackingRequest extends BaseRequest {
+  identifiers!: Identifier[];
+}

package/src/responses/index.ts

@@ -33,3 +33,5 @@ export * from './void-labels-response-schema';
 export * from './void-labels-response';
 export * from './update-settings-response-schema';
 export * from './update-settings-response';
+export * from './start-tracking-response';
+export * from './start-tracking-response-schema';

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

@@ -0,0 +1,14 @@
+import Joi from 'joi';
+import { IdentifierSchema } from '../models/identifier-schema';
+import { BaseResponseSchema } from './base-response-schema';
+import { SubscriptionStatusSchema } from '../models/tracking/start-tracking-status-schema';
+
+export const SubscriptionResultSchema = Joi.object({
+  identifier: IdentifierSchema.required(),
+  status: SubscriptionStatusSchema,
+  message: Joi.string().required(),
+});
+
+export const StartTrackingResponseSchema = BaseResponseSchema.keys({
+  subscription_results: Joi.array().required().items(SubscriptionResultSchema),
+});

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

@@ -0,0 +1,16 @@
+import { BaseResponse } from './base-response';
+import { Identifier } from '../models';
+import { StartTrackingStatus } from '../models/tracking/start-tracking-status';
+
+/**
+ * @description Response from start tracking subscriptions
+ */
+export class StartTrackingResponse extends BaseResponse {
+  subscription_results!: SubscriptionResult[];
+}
+
+export interface SubscriptionResult {
+  identifier: Identifier;
+  status: StartTrackingStatus;
+  message: string;
+}