@shipengine/connect-order-source-api
Version:
This is the typescript/javascript definitions for the order source api
41 lines • 1.57 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.NoteSchema = exports.Note = exports.NoteTypeSchema = exports.NoteType = void 0;
const tslib_1 = require("tslib");
const joi_1 = tslib_1.__importDefault(require("joi"));
/**
* @description The standardized type associated with a note
*/
var NoteType;
(function (NoteType) {
NoteType["BackOrderMessage"] = "BackOrderMessage";
NoteType["ConditionNote"] = "ConditionNote";
NoteType["GiftMessage"] = "GiftMessage";
NoteType["InternalNotes"] = "InternalNotes";
NoteType["InStockMessage"] = "InStockMessage";
NoteType["MPN"] = "MPN";
NoteType["NotesFromBuyer"] = "NotesFromBuyer";
NoteType["NotesToBuyer"] = "NotesToBuyer";
NoteType["Other"] = "Other";
NoteType["OutOfStockMessage"] = "OutOfStockMessage";
NoteType["Reason"] = "Reason";
NoteType["SpecialInstructions"] = "SpecialInstructions";
NoteType["WarningLabel"] = "WarningLabel";
NoteType["FeedbackMessage"] = "FeedbackMessage";
})(NoteType || (exports.NoteType = NoteType = {}));
exports.NoteTypeSchema = joi_1.default.string().valid(...Object.values(NoteType));
/**
* @description This represents a note to the buyer, seller, or recipient
*/
class Note {
/** @description The type of note being sent */
type;
/** @description The contents of the note */
text;
}
exports.Note = Note;
exports.NoteSchema = joi_1.default.object({
type: exports.NoteTypeSchema.required(),
text: joi_1.default.string().required(),
});
//# sourceMappingURL=note.js.map