@shipengine/connect-order-source-api/lib/models/custom-field-option.js

This is the typescript/javascript definitions for the order source api

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.CustomFieldOptionSchema = exports.CustomFieldOption = void 0;
const tslib_1 = require("tslib");
const joi_1 = tslib_1.__importDefault(require("joi"));
/**
 * @description A Custom Field Option describes a possible value that a store could
 * send as a `sales_order_field_mapping` during `sales_orders_export` requests
 */
class CustomFieldOption {
    /**
     * @description The name of the field being requested, which will be sent as`custom_field_*` when chosen by the seller.
     * This value is expected to be unique per integration.
     */
    Field;
    /** @description The name of this option to use in the UI */
    DisplayName;
    /** @description Set to true if this option must be enabled by support */
    IsAdmin;
    /**
     * @description Set to true if this option shouldn't be shown in the UI.
     * This does not prevent the option from being sent to the API for stores which have already chosen it
     */
    IsDeprecated;
}
exports.CustomFieldOption = CustomFieldOption;
exports.CustomFieldOptionSchema = joi_1.default.object({
    Field: joi_1.default.string().required(),
    DisplayName: joi_1.default.string().required(),
    IsAdmin: joi_1.default.boolean().default(false),
    IsDeprecated: joi_1.default.boolean().default(false),
});
//# sourceMappingURL=custom-field-option.js.map