@shipengine/connect-carrier-api 4.5.5 → 4.6.0

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 } from '../requests';
-import { RegisterResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse, ValidateInboundDataResponse, NormalizeTrackingDataResponse, GetRelayPointsResponse, GetServicePointsResponse, GetServicePointResponse } from '../responses';
+import { RegisterRequest, CreateLabelRequest, VoidLabelsRequest, CreateManifestRequest, GetManifestRequest, SchedulePickupRequest, CancelPickupRequest, GetRatesRequest, TrackingRequest, CancelNotificationRequest, CreateNotificationRequest, ValidateInboundDataRequest, NormalizeTrackingDataRequest, GetRelayPointsRequest, GetServicePointsRequest, GetServicePointRequest, ImportTrackingEventsRequest, UpdateSettingsRequest } from '../requests';
+import { RegisterResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse, ValidateInboundDataResponse, NormalizeTrackingDataResponse, GetRelayPointsResponse, GetServicePointsResponse, GetServicePointResponse, UpdateSettingsResponse } from '../responses';
 import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
 import { RequestResponseInfo, Handler } from '@shipengine/connect-runtime';
 /**
@@ -101,6 +101,11 @@ export interface CarrierAppDefinition {
     redactExternalRequest?: (req: RequestResponseInfo) => Promise<RequestResponseInfo> | RequestResponseInfo;
     /** @description A method that gets additional information to return with the diagnostic version route */
     getAdditionalVersionInfo?: () => Promise<Record<string, string>> | Record<string, string>;
+    /**
+     * @description This endpoint is used to update carrier settings
+     * @param request Data needed by the provider to update carrier settings
+     */
+    UpdateSettings?: (request: UpdateSettingsRequest) => UpdateSettingsResponse | Promise<UpdateSettingsResponse>;
     /**
      * @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

@@ -15,5 +15,6 @@ export declare enum ApiEndpoints {
     GetRelayPoints = "/GetRelayPoints",
     GetServicePoints = "/GetServicePoints",
     GetServicePoint = "/GetServicePoint",
-    ImportTrackingEvents = "/ImportTrackingEvents"
+    ImportTrackingEvents = "/ImportTrackingEvents",
+    UpdateSettings = "/UpdateSettings"
 }

package/lib/app/constants.js

@@ -20,5 +20,6 @@ var ApiEndpoints;
     ApiEndpoints["GetServicePoints"] = "/GetServicePoints";
     ApiEndpoints["GetServicePoint"] = "/GetServicePoint";
     ApiEndpoints["ImportTrackingEvents"] = "/ImportTrackingEvents";
+    ApiEndpoints["UpdateSettings"] = "/UpdateSettings";
 })(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,YAkBX;AAlBD,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;AAChD,CAAC,EAlBW,YAAY,4BAAZ,YAAY,QAkBvB"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/app/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAmBX;AAnBD,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;AACpC,CAAC,EAnBW,YAAY,4BAAZ,YAAY,QAmBvB"}

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

@@ -23,6 +23,7 @@ const createEndpointMapping = (definition) => [
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.GetServicePoints, definition.GetServicePoints],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.GetServicePoint, definition.GetServicePoint],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.ImportTrackingEvents, definition.ImportTrackingEvents],
+    [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.UpdateSettings, definition.UpdateSettings],
     ...(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,GAAG,IAAA,+BAAa,EAAC,UAAU,CAAC,UAAU,CAAC;CACxC,CAAC;AAvBW,QAAA,qBAAqB,yBAuBhC"}
+{"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,GAAG,IAAA,+BAAa,EAAC,UAAU,CAAC,UAAU,CAAC;CACxC,CAAC;AAxBW,QAAA,qBAAqB,yBAwBhC"}

package/lib/models/addresses/ship-to.d.ts

@@ -4,4 +4,6 @@ import { TaxIdentifier } from '../taxes/tax-identifier';
 export declare class ShipTo extends AddressBase {
     /** @description Tax IDs associated with the consignee */
     tax_identifiers?: TaxIdentifier[];
+    /** @description what3words field to help identify the location */
+    what3words?: string;
 }

package/lib/models/addresses/ship-to.js

@@ -6,6 +6,8 @@ const address_base_1 = require("./address-base");
 class ShipTo extends address_base_1.AddressBase {
     /** @description Tax IDs associated with the consignee */
     tax_identifiers;
+    /** @description what3words field to help identify the location */
+    what3words;
 }
 exports.ShipTo = ShipTo;
 //# sourceMappingURL=ship-to.js.map

package/lib/models/addresses/ship-to.js.map

@@ -1 +1 @@
-{"version":3,"file":"ship-to.js","sourceRoot":"","sources":["../../../src/models/addresses/ship-to.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAG7C,oEAAoE;AACpE,MAAa,MAAO,SAAQ,0BAAW;IACrC,yDAAyD;IACzD,eAAe,CAAmB;CACnC;AAHD,wBAGC"}
+{"version":3,"file":"ship-to.js","sourceRoot":"","sources":["../../../src/models/addresses/ship-to.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAG7C,oEAAoE;AACpE,MAAa,MAAO,SAAQ,0BAAW;IACrC,yDAAyD;IACzD,eAAe,CAAmB;IAClC,kEAAkE;IAClE,UAAU,CAAU;CACrB;AALD,wBAKC"}

package/lib/requests/index.d.ts

@@ -15,3 +15,4 @@ export * from './schedule-pickup-request';
 export * from './tracking-request';
 export * from './validate-inbound-data-request';
 export * from './void-labels-request';
+export * from './update-settings-request';

package/lib/requests/index.js

@@ -18,4 +18,5 @@ tslib_1.__exportStar(require("./schedule-pickup-request"), exports);
 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);
 //# 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,6DAAmC;AACnC,0EAAgD;AAChD,gEAAsC"}
+{"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,6DAAmC;AACnC,0EAAgD;AAChD,gEAAsC;AACtC,oEAA0C"}

package/lib/requests/update-settings-request.d.ts

@@ -0,0 +1,5 @@
+import { BaseRequest } from './base-request';
+/** @description Basic structure for a request to update carrier settings*/
+export declare class UpdateSettingsRequest extends BaseRequest {
+    update_settings: object;
+}

package/lib/requests/update-settings-request.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateSettingsRequest = void 0;
+const base_request_1 = require("./base-request");
+/** @description Basic structure for a request to update carrier settings*/
+class UpdateSettingsRequest extends base_request_1.BaseRequest {
+    update_settings;
+}
+exports.UpdateSettingsRequest = UpdateSettingsRequest;
+//# sourceMappingURL=update-settings-request.js.map

package/lib/requests/update-settings-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-settings-request.js","sourceRoot":"","sources":["../../src/requests/update-settings-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAE7C,2EAA2E;AAC3E,MAAa,qBAAsB,SAAQ,0BAAW;IACpD,eAAe,CAAU;CAC1B;AAFD,sDAEC"}

package/lib/responses/index.d.ts

@@ -29,3 +29,5 @@ export * from './validate-inbound-data-response-schema';
 export * from './validate-inbound-data-response';
 export * from './void-labels-response-schema';
 export * from './void-labels-response';
+export * from './update-settings-response-schema';
+export * from './update-settings-response';

package/lib/responses/index.js

@@ -32,4 +32,6 @@ tslib_1.__exportStar(require("./validate-inbound-data-response-schema"), exports
 tslib_1.__exportStar(require("./validate-inbound-data-response"), exports);
 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);
 //# 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,qEAA2C;AAC3C,8DAAoC;AACpC,kFAAwD;AACxD,2EAAiD;AACjD,wEAA8C;AAC9C,iEAAuC"}
+{"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,qEAA2C;AAC3C,8DAAoC;AACpC,kFAAwD;AACxD,2EAAiD;AACjD,wEAA8C;AAC9C,iEAAuC;AACvC,4EAAkD;AAClD,qEAA2C"}

package/lib/responses/update-settings-response-schema.d.ts

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

package/lib/responses/update-settings-response-schema.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateSettingsResponseSchema = void 0;
+const tslib_1 = require("tslib");
+const base_response_schema_1 = require("./base-response-schema");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+exports.UpdateSettingsResponseSchema = base_response_schema_1.BaseResponseSchema.keys({
+    metadata: joi_1.default.object().pattern(/.*/, [joi_1.default.any()]).required(),
+});
+//# sourceMappingURL=update-settings-response-schema.js.map

package/lib/responses/update-settings-response-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-settings-response-schema.js","sourceRoot":"","sources":["../../src/responses/update-settings-response-schema.ts"],"names":[],"mappings":";;;;AAAA,iEAA4D;AAC5D,sDAAsB;AAET,QAAA,4BAA4B,GAAG,yCAAkB,CAAC,IAAI,CAAC;IAClE,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/responses/update-settings-response.d.ts

@@ -0,0 +1,4 @@
+/** @description Basic structure for a response to update carrier settings */
+export declare class UpdateSettingsResponse {
+    metadata: object;
+}

package/lib/responses/update-settings-response.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateSettingsResponse = void 0;
+/** @description Basic structure for a response to update carrier settings */
+class UpdateSettingsResponse {
+    metadata;
+}
+exports.UpdateSettingsResponse = UpdateSettingsResponse;
+//# sourceMappingURL=update-settings-response.js.map

package/lib/responses/update-settings-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-settings-response.js","sourceRoot":"","sources":["../../src/responses/update-settings-response.ts"],"names":[],"mappings":";;;AAAA,6EAA6E;AAC7E,MAAa,sBAAsB;IACjC,QAAQ,CAAU;CACnB;AAFD,wDAEC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.5.5",
+  "version": "4.6.0",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",
@@ -44,7 +44,7 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@shipengine/connect-runtime": "^4.5.1",
+    "@shipengine/connect-runtime": "^4.6.0",
     "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.19.5"
+    "version": "1.19.8"
   },
   "paths": {
     "/Register": {
@@ -605,6 +605,37 @@
         }
       }
     },
+    "/UpdateSettings": {
+      "post": {
+        "tags": [
+          "Account Setup"
+        ],
+        "description": "This method is used to update carrier settings.",
+        "operationId": "Update Settings",
+        "requestBody": {
+          "description": "An object containing the settings information that you wish to be updated for a given carrier.",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateSettingsRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The Update Settings method updates carrier settings that were set up during the registration of a given carrier",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UpdateSettingsResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/ValidateShipment": {
       "post": {
         "tags": [
@@ -3801,6 +3832,11 @@
             },
             "description": "Tax IDs associated with the consignee.",
             "nullable": true
+          },
+          "what3words": {
+            "type": "string",
+            "description": "What3words field to help identify the location.",
+            "nullable": true
           }
         },
         "additionalProperties": false
@@ -4295,6 +4331,38 @@
         ],
         "type": "string"
       },
+      "UpdateSettingsRequest": {
+        "required": [
+          "update_settings",
+          "transaction_id"
+        ],
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseRequest"
+          }
+        ],
+        "properties": {
+          "update_settings": {
+            "type": "object",
+            "additionalProperties": { },
+            "description": "This is a schemaless object used to contain any required fields for updating carrier settings.",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false,
+        "description": "This model represents the body of a request used to update carrier settings within ShipEngine."
+      },
+      "UpdateSettingsResponse": {
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseResponse"
+          }
+        ],
+        "additionalProperties": false,
+        "description": "This model represents the successful response for updating carrier settings request."
+      },
       "ValidateInboundDataRequest": {
         "required": [
           "transaction_id"

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

@@ -18,6 +18,7 @@ import {
   GetServicePointsRequest,
   GetServicePointRequest,
   ImportTrackingEventsRequest,
+  UpdateSettingsRequest,
 } from '../requests';
 
 import {
@@ -36,6 +37,7 @@ import {
   GetRelayPointsResponse,
   GetServicePointsResponse,
   GetServicePointResponse,
+  UpdateSettingsResponse,
 } from '../responses';
 
 import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
@@ -167,6 +169,13 @@ export interface CarrierAppDefinition {
   ) => Promise<RequestResponseInfo> | RequestResponseInfo;
   /** @description A method that gets additional information to return with the diagnostic version route */
   getAdditionalVersionInfo?: () => Promise<Record<string, string>> | Record<string, string>;
+  /**
+   * @description This endpoint is used to update carrier settings
+   * @param request Data needed by the provider to update carrier settings
+   */
+  UpdateSettings?: (
+    request: UpdateSettingsRequest,
+  ) => UpdateSettingsResponse | Promise<UpdateSettingsResponse>;
   /**
    * @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

@@ -16,4 +16,5 @@ export enum ApiEndpoints {
   GetServicePoints = '/GetServicePoints',
   GetServicePoint = '/GetServicePoint',
   ImportTrackingEvents = '/ImportTrackingEvents',
+  UpdateSettings = '/UpdateSettings',
 }

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

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

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

@@ -5,4 +5,6 @@ import { TaxIdentifier } from '../taxes/tax-identifier';
 export class ShipTo extends AddressBase {
   /** @description Tax IDs associated with the consignee */
   tax_identifiers?: TaxIdentifier[];
+  /** @description what3words field to help identify the location */
+  what3words?: string;
 }

package/src/requests/index.ts

@@ -15,3 +15,4 @@ export * from './schedule-pickup-request';
 export * from './tracking-request';
 export * from './validate-inbound-data-request';
 export * from './void-labels-request';
+export * from './update-settings-request';

package/src/requests/update-settings-request.ts

@@ -0,0 +1,6 @@
+import { BaseRequest } from './base-request';
+
+/** @description Basic structure for a request to update carrier settings*/
+export class UpdateSettingsRequest extends BaseRequest {
+  update_settings!: object;
+}

package/src/responses/index.ts

@@ -29,3 +29,5 @@ export * from './validate-inbound-data-response-schema';
 export * from './validate-inbound-data-response';
 export * from './void-labels-response-schema';
 export * from './void-labels-response';
+export * from './update-settings-response-schema';
+export * from './update-settings-response';

package/src/responses/update-settings-response-schema.ts

@@ -0,0 +1,6 @@
+import { BaseResponseSchema } from './base-response-schema';
+import Joi from 'joi';
+
+export const UpdateSettingsResponseSchema = BaseResponseSchema.keys({
+  metadata: Joi.object().pattern(/.*/, [Joi.any()]).required(),
+});

package/src/responses/update-settings-response.ts

@@ -0,0 +1,4 @@
+/** @description Basic structure for a response to update carrier settings */
+export class UpdateSettingsResponse {
+  metadata!: object;
+}