src/helpers/import/CsvExampleFile.js

import CsvExampleFileModel from '../../models/import/CsvExampleFile';
import Helper from '../Helper';
import { aggregate } from '../../utilities/ClassUtility';

/**
 * Helper class representing a csv example file.
 *
 * @extends {CsvExampleFileModel}
 * @extends {Helper}
 *
 * @example
 * import { CsvExampleFile, importService } from 'clinical6';
 *
 * // Typically use importService.getExampleFiles(CsvExampleFile)
 * importService.getExampleFiles(CsvExampleFile).then(files => console.log(files));
 *
 * const file = new CsvExampleFile({
 *   data: {
 *     id: 1,
 *     type: "csv_example_files",
 *     attributes: {
 *       platform_model: "Trials::Site",
 *       human_readable_name: "sites",
 *       file_url: "/uploads/test/csv_example_file/file/1/sample.xml"
 *     }
 *   }
 * });
 */
class CsvExampleFile extends aggregate(CsvExampleFileModel, Helper) {
  /** @type {String}  - The type */
  static get type() {
    return 'csv_example_files';
  }
}

export default CsvExampleFile;