@shipengine/connect-order-source-api
Version:
This is the typescript/javascript definitions for the order source api
37 lines • 1.87 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ShipmentNotificationResultSchema = exports.ShipmentNotificationResult = exports.NotificationStatus = void 0;
const tslib_1 = require("tslib");
const joi_1 = tslib_1.__importDefault(require("joi"));
var NotificationStatus;
(function (NotificationStatus) {
NotificationStatus["success"] = "success";
NotificationStatus["failure"] = "failure";
NotificationStatus["pending"] = "pending,";
})(NotificationStatus || (exports.NotificationStatus = NotificationStatus = {}));
/** @description The result of an individual shipment notification request */
class ShipmentNotificationResult {
/** @description The notification id from the request */
notification_id;
/** @deprecated This property has been deprecated, please use status. */
succeeded;
/** @description Indicates the status for the third party receiving this notification */
status;
/** @description An optional confirmation code associated with this notification */
confirmation_code;
/** @description If succeeded was false use this field to indicate why */
failure_reason;
/**
* @description A unique identifier that is used to query the third party about the status of this notification in the notification_status endpoint
* @example "123245AB23", "{'id1': 123, 'id2': 'unique'}"
*/
submission_id;
}
exports.ShipmentNotificationResult = ShipmentNotificationResult;
exports.ShipmentNotificationResultSchema = joi_1.default.object({
notification_id: joi_1.default.string().required(),
succeeded: joi_1.default.bool().optional(),
status: joi_1.default.string().optional().empty().valid('success', 'failure', 'pending'),
submission_id: joi_1.default.string().optional().empty(),
});
//# sourceMappingURL=shipment-notification-result.js.map