/**
 * @module compta
 * @category API
 * @subcategory Models
 * @author Louan L. <louan.leplae@supinfo.com>
 */

import { DataTypes } from "sequelize";

/**
 * @const
 * @type {Object}
 *
 * @example
 * {
 *  compta_id: {
 *    type: DataTypes.INTEGER,
 *    primaryKey: boolean,
 *    allowNull: boolean,
 *    autoIncrement: boolean
 *  },
 *  payment_type: {
 *    type: DataTypes.ENUM,
 *    values: string[],
 *    allowNull: boolean
 *  },
 *  relance: {
 *    type: DataTypes.BOOLEAN,
 *    defaultValue: boolean,
 *    allowNull: boolean
 *  },
 *  paid: {
 *    type: DataTypes.BOOLEAN,
 *    defaultValue: boolean,
 *    allowNull: boolean
 *  },
 *  payment_due: {
 *    type: DataTypes.DECIMAL,
 *    defaultValue: number,
 *    allowNull: boolean
 *  }
 * }
 */
const compta = {
	compta_id: {
		type: DataTypes.INTEGER,
		primaryKey: true,
		allowNull: false,
		autoIncrement: true,
	},
	payment_type: {
		type: DataTypes.ENUM,
		values: [ "OPCA", "Comptant", "Échelonnement" ],
		allowNull: false,
	},
	payment_due: {
		type: DataTypes.DECIMAL(17, 2),
		defaultValue: 0,
		allowNull: false,
	},
	paid: {
		type: DataTypes.DECIMAL(17, 2),
		defaultValue: 0,
		allowNull: false,
	},
};

/**
 * Define the model
 * @function
 *
 * @param {Sequelize} sequelize
 * @param {string} name - The file name used for the definition
 */
export const define = (sequelize, name) => {
	sequelize.define(name, compta);
};

export default compta;